refactor(docs): remove documentation from monorepo - #54
Draft
Athemis wants to merge 1 commit into
Draft
Conversation
Documentation now lives in dbrepo-docs repo.
There was a problem hiding this comment.
Pull request overview
This PR removes the MkDocs-based documentation site from the monorepo in preparation for hosting docs in dbrepo-project/dbrepo-docs.
Changes:
- Deleted
mkdocs.ymland the entiredocs/documentation tree (pages, assets, overrides, OpenAPI helper files). - Removed the
DOC_VERSIONvariable from the rootMakefile. - Removed the
gen-docs-docMake target (but other docs-related generation targets/refs remain).
Important note: As implemented, the monorepo still contains docs-related build hooks (e.g., make/gen.mk: gen-openapi-doc) and external automation (e.g., .gitlab-ci.yml) still expects gen-docs-doc, ./site/*, and ./docs/.openapi/*. This will break the docs/release pipeline unless those are updated as part of this PR or in a coordinated follow-up.
Reviewed changes
Copilot reviewed 94 out of 281 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Removed MkDocs site configuration. |
| Makefile | Removed DOC_VERSION variable. |
| make/gen.mk | Removed gen-docs-doc target (docs generation step). |
| docs/why.md | Removed documentation page (moved out of repo). |
| docs/user-guide/update-visibility.md | Removed documentation page (moved out of repo). |
| docs/user-guide/quickstart.md | Removed documentation page (moved out of repo). |
| docs/user-guide/index.md | Removed documentation page (moved out of repo). |
| docs/user-guide/import-live-data.md | Removed documentation page (moved out of repo). |
| docs/user-guide/import-dataset.md | Removed documentation page (moved out of repo). |
| docs/user-guide/get-data.md | Removed documentation page (moved out of repo). |
| docs/user-guide/delete-database.md | Removed documentation page (moved out of repo). |
| docs/user-guide/database-dashboard.md | Removed documentation page (moved out of repo). |
| docs/user-guide/database-access.md | Removed documentation page (moved out of repo). |
| docs/user-guide/create-subset.md | Removed documentation page (moved out of repo). |
| docs/user-guide/create-pid.md | Removed documentation page (moved out of repo). |
| docs/user-guide/create-database.md | Removed documentation page (moved out of repo). |
| docs/user-guide/create-account.md | Removed documentation page (moved out of repo). |
| docs/stylesheets/extra.scss | Removed docs styling source. |
| docs/stylesheets/extra.css.map | Removed docs styling sourcemap. |
| docs/stylesheets/extra.css | Removed docs styling output. |
| docs/publications.md | Removed documentation page (moved out of repo). |
| docs/presentations/.gitkeep | Removed/unused docs placeholder content. |
| docs/papers/weise2022dbrepo.xml | Removed docs asset (publication export). |
| docs/papers/weise2022dbrepo.ris | Removed docs asset (publication export). |
| docs/papers/weise2022dbrepo.rdf | Removed docs asset (publication export). |
| docs/papers/weise2022dbrepo.bib | Removed docs asset (publication export). |
| docs/overrides/partials/copyright.html | Removed MkDocs Material override. |
| docs/overrides/main.html | Removed MkDocs Material override. |
| docs/overrides/.icons/wikimedia/open-access.svg | Removed docs icon asset. |
| docs/maintainer-guide/updating.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/troubleshooting.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/restore-data.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/install-vm.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/install-kubernetes.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/install-docker.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/index.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/configuration.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/build-source.md | Removed documentation page (moved out of repo). |
| docs/maintainer-guide/backup-data.md | Removed documentation page (moved out of repo). |
| docs/kubernetes.md | Removed documentation page (moved out of repo). |
| docs/installation.md | Removed documentation page (moved out of repo). |
| docs/index.md | Removed documentation landing page content. |
| docs/index.html.tpl | Removed docs redirect template. |
| docs/images/TU_Signet_weiss_transparent_300dpi_RGB.png | Removed docs image asset. |
| docs/images/signet_black.png | Removed docs image asset. |
| docs/images/security.svg | Removed docs badge/asset. |
| docs/images/pulls.svg | Removed docs badge/asset. |
| docs/images/pipeline.svg | Removed docs badge/asset. |
| docs/images/maintainability.svg | Removed docs badge/asset. |
| docs/images/logos/favicon.svg | Removed docs favicon asset. |
| docs/images/coverage.svg | Removed docs badge/asset. |
| docs/images/branching-strategy.svg | Removed docs diagram asset. |
| docs/help.md | Removed documentation page (moved out of repo). |
| docs/get-started.md | Removed documentation page (moved out of repo). |
| docs/examples/xps-data.md | Removed documentation page (moved out of repo). |
| docs/examples/transportation.md | Removed documentation page (moved out of repo). |
| docs/examples/theater.md | Removed documentation page (moved out of repo). |
| docs/examples/survey.md | Removed documentation page (moved out of repo). |
| docs/examples/power.md | Removed documentation page (moved out of repo). |
| docs/examples/pls-data.md | Removed documentation page (moved out of repo). |
| docs/examples/music.md | Removed documentation page (moved out of repo). |
| docs/examples/lute-data.md | Removed documentation page (moved out of repo). |
| docs/examples/index.md | Removed documentation page (moved out of repo). |
| docs/examples/health.md | Removed documentation page (moved out of repo). |
| docs/examples/hazard.md | Removed documentation page (moved out of repo). |
| docs/examples/covid-19.md | Removed documentation page (moved out of repo). |
| docs/examples/air.md | Removed documentation page (moved out of repo). |
| docs/dev/services/ui.md | Removed documentation page (moved out of repo). |
| docs/dev/services/storage-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/search-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/search-db.md | Removed documentation page (moved out of repo). |
| docs/dev/services/metric-db.md | Removed documentation page (moved out of repo). |
| docs/dev/services/metadata-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/metadata-db.md | Removed documentation page (moved out of repo). |
| docs/dev/services/identity-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/gateway-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/data-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/data-db.md | Removed documentation page (moved out of repo). |
| docs/dev/services/dashboard-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/cache-db.md | Removed documentation page (moved out of repo). |
| docs/dev/services/broker-service.md | Removed documentation page (moved out of repo). |
| docs/dev/services/auth-service.md | Removed documentation page (moved out of repo). |
| docs/dev/index.md | Removed documentation page (moved out of repo). |
| docs/dev/contributing.md | Removed documentation page (moved out of repo). |
| docs/dev/changelog.md | Removed documentation page (moved out of repo). |
| docs/deployment.md | Removed documentation page (moved out of repo). |
| docs/customization.md | Removed documentation page (moved out of repo). |
| docs/contact.md | Removed documentation page (moved out of repo). |
| docs/api/rest.tpl | Removed docs template for REST API page generation. |
| docs/api/python.tpl | Removed docs template for Python API page. |
| docs/api/python.md | Removed documentation page (moved out of repo). |
| docs/api/oai-pmh.md | Removed documentation page (moved out of repo). |
| docs/api/json-ld.md | Removed documentation page (moved out of repo). |
| docs/api/index.md | Removed documentation page (moved out of repo). |
| docs/api/fair-signposting.md | Removed documentation page (moved out of repo). |
| docs/api/broker.md | Removed documentation page (moved out of repo). |
| docs/.prometheus/metrics-generate.sh | Removed docs-related metrics generation script. |
| docs/.openapi/swagger-ui.html | Removed docs OpenAPI Swagger UI wrapper. |
| docs/.openapi/openapi-merge.json | Removed OpenAPI merge configuration. |
| docs/.openapi/openapi-generate.sh | Removed OpenAPI generation script. |
| docs/.openapi/custom.css | Removed Swagger UI custom styling. |
| docs/.openapi/api.base.yaml | Removed OpenAPI base definition. |
| docs/.openapi/.gitignore | Removed docs OpenAPI gitignore. |
| docs/.gitignore | Removed docs-specific gitignore. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
12
to
19
| .PHONY: gen-helm-doc | ||
| gen-helm-doc: build-helm ## Generate Helm documentation and schema | ||
| helm schema --values ./helm/dbrepo/values.yaml --output ./helm/dbrepo/values.schema.json | ||
| readme-generator --readme ./helm/dbrepo/README.md --values ./helm/dbrepo/values.yaml | ||
|
|
||
| .PHONY: gen-dbrepo-doc | ||
| gen-docs-doc: ## Generate DBRepo documentation. | ||
| mike deploy $DOC_VERSION latest | ||
| mike set-default latest | ||
|
|
||
| .PHONY: gen-python-doc | ||
| gen-python-doc: ## Generate Python Library documentation. | ||
| bash ./lib/python/build-site.sh |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation is being extracted to dbrepo-project/dbrepo-docs. This PR removes docs and related traces from the monorepo.
Description
Please provide a brief description of the changes in this pull request.
Type of Change
Checklist