feat(docs): Migrate to central ODG documentation#874
Conversation
zkdev
added
kind/task
|
Warning Review limit reached
Next review available in: 57 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (12)
📒 Files selected for processing (20)
📝 WalkthroughWalkthroughIntroduces a new Makefile, CI, and README
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Around line 102-106: The Makefile’s runserver target builds the delivery DB
URL by interpolating DB_USER/DB_PASSWORD directly into the URI, which breaks
when the password contains reserved characters. Update the run target around the
runserver invocation to avoid raw string interpolation—either pass the DB URL
via an encoded/override-safe variable or construct it using proper URL escaping
before handing it to adev runserver. Keep the existing delivery-db-url wiring,
but ensure the value is safe for credentials with characters like @, :, /, and
%.
- Around line 51-53: The test target is passing an empty positional argument
through the Makefile, which can be interpreted by the test runner as a path.
Update the test target in Makefile so the command that invokes the .ci/test
script does not include the empty argument, and keep the existing test
entrypoint behavior otherwise.
In `@README.md`:
- Line 20: The README description uses an incorrect relative link for Open
Component Model; update the Markdown in the README text that mentions
ocm.software so it points to the external site instead of a repo-relative path.
Locate the existing hyperlink near the API overview and replace it with the
proper absolute URL while keeping the surrounding sentence unchanged.
- Line 16: The Packages table-of-contents link points to the wrong anchor, so
update the markdown entry to match the actual heading-generated slug for the
README’s Packages section. Locate the TOC item labeled Packages and change its
target from the incorrect anchor to the one produced by the `## Packages`
heading so the link resolves correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d7b4d064-7a28-444c-976f-302a501ff404
⛔ Files ignored due to path filters (12)
docs/clamav/clamav-to-delivery-gear-extensions.pngis excluded by!**/*.pngdocs/clamav/clamav-to-delivery-gear-extensions.svgis excluded by!**/*.svgdocs/delivery-db-backup/delivery-db-backup-cronjob.pngis excluded by!**/*.pngdocs/delivery-db-backup/delivery-db-backup-cronjob.svgis excluded by!**/*.svgdocs/res/artefact-metadata.svgis excluded by!**/*.svgdocs/res/download-sbom-button.svgis excluded by!**/*.svgdocs/res/download-sbom-popover.svgis excluded by!**/*.svgdocs/res/favicon.icois excluded by!**/*.icodocs/res/finding-states.svgis excluded by!**/*.svgdocs/res/general-overview.svgis excluded by!**/*.svgdocs/res/issues-overview.svgis excluded by!**/*.svgdocs/res/sbom-generator-overview.svgis excluded by!**/*.svg
📒 Files selected for processing (20)
.github/workflows/build.yamlMakefileREADME.mddocs/artefact_metadata_query.rstdocs/clamav/clamav-to-delivery-gear-extensions.excalidrawdocs/conf.pydocs/contribute_extension.rstdocs/css/custom.cssdocs/delivery-db-backup/delivery-db-backup-cronjob.excalidrawdocs/delivery_service.rstdocs/extensions/artefact_enumerator.rstdocs/extensions/diki.rstdocs/extensions/issue_replicator.rstdocs/extensions/responsibles.rstdocs/extensions/sbom_generator.rstdocs/index.rstdocs/local_setup.rstdocs/model.rstdocs/res/issues-overview.excalidrawdocs/res/sbom-generator.excalidraw
💤 Files with no reviewable changes (16)
- docs/index.rst
- docs/extensions/diki.rst
- docs/extensions/sbom_generator.rst
- docs/contribute_extension.rst
- docs/extensions/responsibles.rst
- docs/res/issues-overview.excalidraw
- docs/css/custom.css
- docs/delivery_service.rst
- docs/extensions/artefact_enumerator.rst
- docs/extensions/issue_replicator.rst
- docs/model.rst
- docs/artefact_metadata_query.rst
- docs/res/sbom-generator.excalidraw
- docs/local_setup.rst
- docs/delivery-db-backup/delivery-db-backup-cronjob.excalidraw
- docs/conf.py
There was a problem hiding this comment.
We must also drop the website/documentation part from this build. Also, will you take care of purging the GitHub pages? :-)
There was a problem hiding this comment.
will do the manual clean up once merged.
pipelines are now also covered, good catch
There is now a central home for ODG related documentation: -> https://github.com/open-component-model/open-delivery-gear Contents have been migrated, therefore they can be safely removed from this repo. Turn the local README into a repository specific document given dev-only instructions. For convenience, introduce a Makefile. Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Philipp Heil <philipp.heil@sap.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Philipp Heil <philipp.heil@sap.com>
Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
Signed-off-by: Philipp Heil (zkdev) <philipp.heil@sap.com>
|
CI is failing as documentation cannot be build. This PR is about dropping documentation build entirely. Thus, can be safely ignored. |
2 participants
What this PR does / why we need it:
Documentation was centralised to https://github.com/open-component-model/open-delivery-gear.
Focus this repository to dev-only instructions.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Release note: