-
Notifications
You must be signed in to change notification settings - Fork 465
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
multiple cleanups in docs #425
Conversation
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.
These are some awesome improvements, thanks for taking them on!
docs-src/security-model.md
Outdated
|
||
There are 3 primary roles in the API: | ||
|
||
- Infrastructure provider | ||
- Cluster Operator | ||
- Application Developer | ||
|
||
There could be a fourth a role of Application Admin in some use cases. | ||
|
||
Please refer to [roles and personas](concepts.md#roles-and-personas) section | ||
in API concepts for details. |
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.
Thanks for cleaning up the duplication between this and the API concepts pages. I'm actually wondering if we should switch these around though. This PR adds all the detail around roles to the API concepts page and leaves a short summary here - maybe the short summary should be in API concepts and the detailed overview should be here. Either way, it's better to not have the full detail in both places, so thanks for fixing that.
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.
SGTM. I've updated to switch this around.
docs-src/concepts.md
Outdated
- Infrastructure provider | ||
- Cluster Operator | ||
- Application Developer |
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.
Tiny nit - capitalization doesn't match on Infrastructure Provider
Some great improvements here, just had a few tiny nits. /approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hbagdi, robscott The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
- consolidate personas in a single doc - add a new guides page which will refer to getting started guides and provide cookbooks; removed cookbookmd and userguide.md as part of this change - re-wrote the intro page to better guide new users - nav corrections and updates based on above changes Co-authored-by: Rob Scott <[email protected]>
Thanks! /lgtm |
provide cookbooks; removed cookbookmd and userguide.md as part of this
change