add docs on adding a project - #111
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Documentation build overview
|
|
@alasdairwilson This seems to require a review. Happy to do it, but it may take a few days. |
sr-murthy
left a comment
There was a problem hiding this comment.
@alasdairwilson Looks fine, but I've left a few comments/suggestions.
There was a problem hiding this comment.
Pull request overview
Adds a new Sphinx documentation page describing the end-to-end process for publishing a new project to the deployed ISARIC VERTEX instance, and updates existing docs to clarify how project_id, initial visibility, and ownership relate to the access database and account management flow.
Changes:
- Added a new “Adding a project to VERTEX” page documenting the VERTEX-projects → server sync → ingestion → access management pipeline.
- Clarified
project_id,is_public, andproject_ownersemantics in the app configuration documentation and linked to the new page. - Included the new page in the documentation toctree.
Reviewed changes
Copilot reviewed 3 out of 11 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/sources/app.rst | Clarifies project metadata fields and points readers to the new deployment/access-management docs. |
| docs/sources/adding-a-project.rst | New end-to-end guide for generating project outputs, PR/merge workflow, ingestion behavior, and access management. |
| docs/index.rst | Adds the new page to the published docs navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Approved, but the base has changed, so needs a rebase. |
PR docs build site