-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Admin overview doc #6412
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
Admin overview doc #6412
Conversation
Craft an Amin Overview and finish up high-level remaining tasks for install docs.
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Spelling fix!
Wrote up admin tasks and interests by categories
Changed H1 to include "Knative"
Link testing and de-emphasizing tables
Link fixes
indented bullets test
Settling on combo or paras with lins and minimal bulleted lists
Worked on Configurations section
Worked on the Monitoring and Observability section
Finished initial write-up for each section
Added blog links (as a test)
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.
This reads more like a table of contents than an overview, at the moment.
Looking at I'm noticing that right now it's largely an exposition of the left-hand nav (or desired left-hand nav), which doesn't feel like the best use of reading time.
If you look at https://knative.dev/docs/, it starts out with "what this document is about".
In this case, I think the document is about something like:
Knative consists of several on-cluster components alongside client tools like
kn
andfunc
. This page explains how to install and manage Knative on an existing Kubernetes cluster. It assumes that you are generally familiar with Kubernetes, Kubernetes administration, thekubectl
command, and have at least some familiarity with the larger CNCF ecosystem. Additionally, it assumes that you have the ability to install software and manage resources in all clusters in the namespace (cluster-admin
permissions, or equivalent). When you've finished, you will understand the different Knative components, their roles, the Knative philosophy, and how to enable your cluster's users to develop using Knative.
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.
Comments and suggestions added. Happy to answer questions or explain my reasoning if you have questions. Please respond in the PR.
If I contradict the style guide, go with the style guide.
Processed most reviewer edits
Added "YAML and CLI installations compared" section
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.
Just a few more items, but I feel like we're getting close.
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Also added KServe to Extensibility section of Installing Knative
link fix
Removed - content now in admin/admin-overview.md
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.
A few smaller corrections, a few of which I connected with you on slack because I was concerned about a longer turn-around time.
|
||
## Authorizations | ||
|
||
You can grant developers access to additional resources related to their namespace in other services, such as observability, logs, metrics, tracing, and dashboards. |
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.
Not for this PR, but we should expand this to also talk about how application access can be managed by using ingress and Eventing features to require specific types of tokens (authentication and authorization) to deliver requests or events.
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Co-authored-by: Evan Anderson <[email protected]>
Removed unneeded reference and link fix
OK to merge |
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.
/lgtm
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: evankanderson, iRaindrop 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 |
Write an Aministration Overview and finish up high-level remaining tasks for install docs.
Proposed Changes