feature/admin-gitdrs #40
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
|
I've updated the calypr_admin sections. We need to update the following pages for git-drs and meta data changes |
✅ Deploy Preview for calypr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR introduces initial support for migrating documentation from gen3-tracker (g3t) to calypr_admin and adds TODO markers indicating that sections need to be rewritten for GitDRS integration. The changes update command references, environment variables, and tool names across the documentation.
- Updates tool references from
gen3-tracker(g3t) tocalypr_adminthroughout the documentation - Changes environment variable from
G3T_PROFILEtoCALYPR_PROFILE - Adds TODO markers (
TODO - rewrite for git-drs) to sections requiring GitDRS documentation updates
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/workflows/tabular.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/status.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/remove-files.md | Adds TODO markers for GitDRS rewrite in multiple sections |
| docs/workflows/quick-start-guide.md | Updates commands from g3t to calypr_admin, changes environment variable to CALYPR_PROFILE, adds multiple TODO markers |
| docs/workflows/query.md | Updates ping command to use calypr_admin, adds TODO marker for grip and dataframer |
| docs/workflows/portal-download.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/metadata.md | Adds TODO markers for GitDRS rewrite |
| docs/workflows/creating-project.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/common-errors.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/commit-push.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/clone.md | Adds TODO marker for GitDRS rewrite |
| docs/workflows/approve-requests.md | Updates collaborator command to calypr_admin (with issues noted) |
| docs/workflows/add-users.md | Updates collaborator commands to calypr_admin, adds command help text |
| docs/workflows/add-files.md | Adds TODO marker for GitDRS rewrite |
| docs/requirements.md | Updates all references from gen3-tracker to calypr_admin, updates environment variable references |
| docs/index.md | Updates main description from gen3-tracker to calypr_admin |
| docs/data-model/metadata.md | Adds TODO marker for GitDRS rewrite |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Create Metadata | ||
|
|
||
| `TODO - rewrite for git-drs` |
There was a problem hiding this comment.
The TODO marker format is inconsistent with other TODO markers in the codebase. Other TODO markers use the format TODO - rewrite for git-drs (without the colon), while this one uses TODO: - rewrite for git-drs (with a colon). Remove the colon for consistency.
| Alternatively, to give another user read access only (without the ability to upload to the project), run the following: | ||
| ```sh | ||
| g3t collaborator add user-read-only@example.com | ||
| calypr_admin collaborator add user-read-only@example.com |
There was a problem hiding this comment.
The command uses collaborator (singular) but should use collaborators (plural) to be consistent with the help text shown above (line 9) which uses calypr_admin collaborators add and the other command on line 35 which also uses collaborators.
| calypr_admin collaborator add user-read-only@example.com | |
| calypr_admin collaborators add user-read-only@example.com |
| g3t collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| calypr_admin collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| # As an admin, approve that request | ||
| g3t collaborator approve |
There was a problem hiding this comment.
The command uses collaborator (singular) but should use collaborators (plural) to be consistent with the update on line 43 in this file and with the naming convention used throughout the codebase.
| ```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 | ||
| g3t collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | ||
| calypr_admin collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward |
There was a problem hiding this comment.
This command on line 43 has a duplicate 'add' word in the command. It should be either calypr_admin collaborator add or calypr_admin collaborators add (the latter to match the naming convention), but not calypr_admin collaborator add add.
| calypr_admin collaborator add add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward | |
| calypr_admin collaborator add data_steward_example@<institution>.edu --resource_path /programs/<program_name>/projects --steward |
Description
This PR introduces initial support for calypr_admin and GitDRS (Git Data Repository Service) integration within the interface of the Calypr github pages.
Motivation and Context
Updates the documentation for users
How Has This Been Tested?
mkdocs serve
Types of Changes
Checklist