Skip to content

Conversation

iRaindrop
Copy link
Contributor

@iRaindrop iRaindrop commented Sep 26, 2025

Write an Aministration Overview and finish up high-level remaining tasks for install docs.

Proposed Changes

  • Add Administration Overview to the doc set. Summarize task areas for a Knative admin with links.

Craft an Amin Overview and finish up high-level remaining tasks for install docs.
@knative-prow knative-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 26, 2025
@iRaindrop iRaindrop marked this pull request as draft September 26, 2025 21:12
@knative-prow knative-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 26, 2025
Copy link

netlify bot commented Sep 26, 2025

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 42c61a7
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/68f03bb5648143000899f7ee
😎 Deploy Preview https://deploy-preview-6412--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Wrote up admin tasks and interests by categories
@knative-prow knative-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 29, 2025
Changed H1 to include "Knative"
Link testing and de-emphasizing tables
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
@knative-prow knative-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 1, 2025
Finished initial write-up for each section
Added blog links (as a test)
@iRaindrop iRaindrop changed the title Admin and Install docs Admin overview doc Oct 2, 2025
Copy link
Member

@evankanderson evankanderson left a 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 and func. 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, the kubectl 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.

Copy link

@dwelsch-esi dwelsch-esi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iRaindrop, @evankanderson

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
Copy link
Member

@evankanderson evankanderson left a 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.

iRaindrop and others added 10 commits October 14, 2025 14:28
Also added KServe to Extensibility section of Installing Knative
Removed - content now in admin/admin-overview.md
Copy link
Member

@evankanderson evankanderson left a 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.
Copy link
Member

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.

@iRaindrop
Copy link
Contributor Author

OK to merge

Copy link
Member

@evankanderson evankanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Oct 16, 2025
Copy link

knative-prow bot commented Oct 16, 2025

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 16, 2025
@knative-prow knative-prow bot merged commit 83cc8c4 into knative:main Oct 16, 2025
19 checks passed
@iRaindrop iRaindrop deleted the bh_admin-install-docs branch October 16, 2025 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants