Enhance permissions-cli.md with ownership templates info#38
Open
bwalsh wants to merge 1 commit into
Open
Conversation
Added detailed documentation on ownership templates for CLI, including explanations, examples, and usage guidance.
Test Coverage ReportOverall Coverage: 60.2% Package Coverage
|
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.
Improve CLI documentation for ownership templates and project creation
Summary
This PR expands the
permissionsdocumentation 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:
Documented the currently supported templates:
gen3-programgen3-projectExplained when each template should be used.
Added examples for creating:
Included diagrams illustrating the resulting resource hierarchy.
Documented the typical lifecycle:
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-descendantcommand but assumed readers already understood: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:
to list the ownership templates supported by the connected server, eliminating the need for users to know template names in advance.