-
Notifications
You must be signed in to change notification settings - Fork 1
Fix command inconsistencies in calypr_admin documentation #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for calypr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…uplicate 'add' Co-authored-by: bwalsh <47808+bwalsh@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Standardizes CLI command examples in the workflow documentation to match the calypr_admin collaborators interface and remove inconsistent/deprecated command syntax.
Changes:
- Replaced
calypr_admin collaborator ...withcalypr_admin collaborators ...in workflow examples. - Removed duplicated
addtoken in the data steward example command. - Updated an approval command example from
g3t collaborator approvetocalypr_admin collaborators approve.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/workflows/add-users.md | Updates the read-only user example to use calypr_admin collaborators add. |
| docs/workflows/approve-requests.md | Updates steward-grant and approval examples to use calypr_admin collaborators ... commands. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```text | ||
| ## As an admin, I need to grant data steward privileges add the requester reader and updater role on a program to an un-privileged user | ||
| calypr_admin collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
calypr_admin collaborators add is shown elsewhere in this repo with a positional [RESOURCE_PATH] argument (and --project_id), but this example uses --resource_path .... Since --resource_path isn't referenced anywhere else in the docs, please verify the actual CLI syntax and align this example (or update the docs/help snippet) to avoid misleading users.
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | |
| calypr_admin collaborators add data_steward_example@<institution>.edu /programs/<program_name>/projects --project_id <project_id> --steward |
| ```text | ||
| ## As an admin, I need to grant data steward privileges add the requester reader and updater role on a program to an un-privileged user | ||
| calypr_admin collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two consecutive spaces before --steward in this shell command (.../projects --steward). Please normalize spacing to improve copy/paste reliability.
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | |
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward |
| calypr_admin collaborators add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| # As an admin, approve that request | ||
| g3t collaborator approve | ||
| calypr_admin collaborators approve |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document still contains an earlier example using the deprecated g3t collaborator approve --help (see the code block starting around line 18). That contradicts the updated calypr_admin collaborators approve usage here and the PR description; please update the earlier help snippet/example to the current calypr_admin collaborators approve --help output (or remove it if no longer applicable).
Addresses review feedback from PR #40 by fixing inconsistent command syntax in the documentation.
Changes
collaborator(singular) tocollaborators(plural) to match the actual CLI interfaceaddincalypr_admin collaborator add add→calypr_admin collaborators addg3t collaborator approvetocalypr_admin collaborators approveFiles Modified
docs/workflows/add-users.md- Line 40: Fixed read-only user commanddocs/workflows/approve-requests.md- Lines 43, 45: Fixed data steward privileges and approval commandsBefore:
After:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.