Skip to content

Conversation

Copy link

Copilot AI commented Jan 22, 2026

Addresses review feedback from PR #40 by fixing inconsistent command syntax in the documentation.

Changes

  • Standardized command naming: Changed all instances of collaborator (singular) to collaborators (plural) to match the actual CLI interface
  • Fixed duplicate command word: Removed duplicate add in calypr_admin collaborator add addcalypr_admin collaborators add
  • Updated deprecated tool reference: Changed g3t collaborator approve to calypr_admin collaborators approve

Files Modified

  • docs/workflows/add-users.md - Line 40: Fixed read-only user command
  • docs/workflows/approve-requests.md - Lines 43, 45: Fixed data steward privileges and approval commands

Before:

calypr_admin collaborator add user@example.com
calypr_admin collaborator add add data_steward@example.edu --steward
g3t collaborator approve

After:

calypr_admin collaborators add user@example.com
calypr_admin collaborators add data_steward@example.edu --steward
calypr_admin collaborators approve

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI mentioned this pull request Jan 22, 2026
6 tasks
@netlify
Copy link

netlify bot commented Jan 22, 2026

Deploy Preview for calypr ready!

Name Link
🔨 Latest commit 6b7aa3b
🔍 Latest deploy log https://app.netlify.com/projects/calypr/deploys/6972871d8b0cf60008a91fd6
😎 Deploy Preview https://deploy-preview-58--calypr.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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>
Copilot AI changed the title [WIP] Add initial support for calypr_admin and GitDRS integration Fix command inconsistencies in calypr_admin documentation Jan 22, 2026
Copilot AI requested a review from bwalsh January 22, 2026 20:23
@bwalsh bwalsh marked this pull request as ready for review January 22, 2026 21:24
Copilot AI review requested due to automatic review settings January 22, 2026 21:24
@bwalsh bwalsh merged commit b8fff78 into feature/admin-gitdrs Jan 22, 2026
4 checks passed
@bwalsh bwalsh deleted the copilot/sub-pr-40 branch January 22, 2026 21:24
Copy link
Contributor

Copilot AI left a 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 ... with calypr_admin collaborators ... in workflow examples.
  • Removed duplicated add token in the data steward example command.
  • Updated an approval command example from g3t collaborator approve to calypr_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
Copy link

Copilot AI Jan 22, 2026

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.

Suggested change
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

Copilot uses AI. Check for mistakes.
```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
Copy link

Copilot AI Jan 22, 2026

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.

Suggested change
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

Copilot uses AI. Check for mistakes.
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
Copy link

Copilot AI Jan 22, 2026

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).

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants