Skip to content

add docs on adding a project - #111

Merged
alasdairwilson merged 4 commits into
mainfrom
add-project-docs
Jul 30, 2026
Merged

add docs on adding a project#111
alasdairwilson merged 4 commits into
mainfrom
add-project-docs

Conversation

@alasdairwilson

@alasdairwilson alasdairwilson commented Jul 13, 2026

Copy link
Copy Markdown
Member

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@read-the-docs-community

read-the-docs-community Bot commented Jul 13, 2026

Copy link
Copy Markdown

Documentation build overview

📚 ISARIC VERTEX | 🛠️ Build #33837709 | 📁 Comparing c244a38 against latest (1a4cd1f)

  🔍 Preview build  

3 files changed
+ sources/adding-a-project.html
± index.html
± sources/app.html

@sr-murthy

Copy link
Copy Markdown
Member

@alasdairwilson This seems to require a review. Happy to do it, but it may take a few days.

@sr-murthy
sr-murthy self-requested a review July 29, 2026 12:40
@sr-murthy sr-murthy added the documentation Improvements or additions to documentation label Jul 29, 2026
sr-murthy
sr-murthy previously approved these changes Jul 29, 2026

@sr-murthy sr-murthy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alasdairwilson Looks fine, but I've left a few comments/suggestions.

Comment thread docs/sources/adding-a-project.rst Outdated
Comment thread docs/sources/adding-a-project.rst Outdated
Comment thread docs/sources/adding-a-project.rst
Comment thread docs/sources/adding-a-project.rst Outdated
Comment thread docs/sources/adding-a-project.rst
Comment thread docs/sources/adding-a-project.rst Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and project_owner semantics 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.

@sr-murthy

Copy link
Copy Markdown
Member

Approved, but the base has changed, so needs a rebase.

@alasdairwilson
alasdairwilson merged commit c6cb1aa into main Jul 30, 2026
13 checks passed
@alasdairwilson
alasdairwilson deleted the add-project-docs branch July 30, 2026 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants