Skip to content

Enhance permissions-cli.md with ownership templates info#38

Open
bwalsh wants to merge 1 commit into
masterfrom
feature/document-templates
Open

Enhance permissions-cli.md with ownership templates info#38
bwalsh wants to merge 1 commit into
masterfrom
feature/document-templates

Conversation

@bwalsh

@bwalsh bwalsh commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Improve CLI documentation for ownership templates and project creation

Summary

This PR expands the permissions documentation to better explain how ownership templates work and how users create new organizations and projects.

The goal is to make the feature understandable for users who are new to Gen3 and Arborist, rather than assuming familiarity with the underlying authorization model.

Changes

  • Added user-centered documentation describing:

    • what an ownership template is
    • why templates exist
    • how templates fit into the Gen3 resource hierarchy
  • Documented the currently supported templates:

    • gen3-program
    • gen3-project
  • Explained when each template should be used.

  • Added examples for creating:

    • organizations
    • projects
  • Included diagrams illustrating the resulting resource hierarchy.

  • Documented the typical lifecycle:

    1. Configure a profile
    2. Create or join an organization
    3. Create a project
    4. Grant collaborator access
    5. Upload data
  • Clarified that ownership templates are defined by the Gen3/Arborist server, not by the CLI.

  • Documented the current limitation that the CLI cannot enumerate available templates.

Motivation

Previous documentation demonstrated the create-descendant command but assumed readers already understood:

  • what a template represents
  • why different templates exist
  • when to choose one template over another
  • where templates are defined

This documentation fills those gaps and provides a more approachable onboarding experience for new users.

Follow-up

A useful future enhancement would be a discovery command such as:

calypr-cli permissions ownership templates

to list the ownership templates supported by the connected server, eliminating the need for users to know template names in advance.

Added detailed documentation on ownership templates for CLI, including explanations, examples, and usage guidance.
@bwalsh bwalsh requested a review from matthewpeterkort July 1, 2026 20:13
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

Test Coverage Report

Overall Coverage: 60.2%

Package Coverage

Package Coverage
arborist 77.1%
conf 54.7%
fence 54.0%
g3client 28.8%
gecko 74.4%
githubutil 53.2%
logs 53.0%
request 79.4%
requestor 84.7%
sower 83.3%

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.

1 participant