Open
Conversation
Signed-off-by: Liam Beckman <lbeckman314@gmail.com>
✅ Deploy Preview for calypr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Quickstart” documentation path and surfaces common workflows directly from the tools landing page, aiming to help users get started with project setup, data transfer, and collaborator management.
Changes:
- Added a “Quickstart: Common Workflows” section to the tools index page with links into Git-DRS and data-client docs.
- Introduced a new
docs/calypr/quickstart/mini-guide (create project, upload/download, collaborators) and navigation for it. - Expanded the admin “Add users” page with collaborator removal instructions and linked the new quickstart section into the Calypr nav.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tools/index.md | Adds a “Quickstart: Common Workflows” section with links and example CLI commands. |
| docs/calypr/quickstart/index.md | New quickstart landing page with prerequisites and 3-step card layout. |
| docs/calypr/quickstart/create-project.md | New guide for requesting a project and configuring Git-DRS. |
| docs/calypr/quickstart/upload-download.md | New guide comparing Git-DRS vs data-client transfers with example commands. |
| docs/calypr/quickstart/collaborators.md | New guide for managing collaborators via data-client (add/remove/approve/list). |
| docs/calypr/quickstart/.nav.yml | Adds navigation structure for the new quickstart section. |
| docs/calypr/project-management/calypr-admin/add-users.md | Adds a new section describing collaborator removal. |
| docs/calypr/.nav.yml | Adds the new “Quickstart” section to Calypr navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| data-client collaborator add [project_id] colleague@example.com --write | ||
|
|
||
| # Remove a collaborator | ||
| data-client collaborator remove [project_id] colleague@example.com |
| Project creation is currently admin-mediated. Contact your data coordinator at `support@calypr.org` to request a new project. You'll receive: | ||
|
|
||
| * GitHub repository URL | ||
| * Calypr project ID |
| To remove a user from a project: | ||
|
|
||
| ```sh | ||
| data-client collaborator remove [project_id] user@example.com |
| - **Gen3 API credentials** downloaded from your [Profile page](https://calypr-public.ohsu.edu/Profile) | ||
|
|
||
| !!! tip "API credentials expire every 30 days" | ||
| Download fresh credentials from your Profile page when they expire and re-run `git drs remote add` to update your configuration. |
Comment on lines
+69
to
+75
| data-client collaborator add [project_id] colleague@example.com | ||
|
|
||
| # Add a collaborator with write access | ||
| data-client collaborator add [project_id] colleague@example.com --write | ||
|
|
||
| # Remove a collaborator | ||
| data-client collaborator remove [project_id] colleague@example.com |
Comment on lines
+29
to
+33
| To remove a user from a project: | ||
|
|
||
| ```sh | ||
| data-client collaborator remove [project_id] user@example.com | ||
| ``` |
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.
Description
Motivation and Context
How Has This Been Tested?
Types of Changes
Checklist