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

knative-prow bot commented Sep 26, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: iRaindrop
Once this PR has been reviewed and has the lgtm label, please assign creydr for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 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 221b573
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/68e7555370c687000837f99e
😎 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
Updated Installation section
Installation, CRD, and ConfigMap guidance
Updates and restructuring sections into Administrative tasks table.
Minor edits to rebuild
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.

Admin table is a good organizational aid.

Page headings don't match the left-sidebar TOC entries:
Administration -> Installing Knative
Administration overview -> Overview
Install Knative with YAML -> About YAML-based installation
etc.

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.

Thanks, this is starting to look better, sorry about the big pile of comments, but it seemed useful at this point to get closer to the details.

- The `kubectl`CLI tool. You can use existing Kubernetes management tools (policy, quota, etc) to manage Knative workloads.
- The Cloud Native Computing Foundation (CNCF) for which Knative is one of its projects, along with Kubernetes, Prometheus, and Istio.

Additionally, you should have cluster-admin permissions or equivalent to to install software and manage resources in all clusters in the namespace.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Additionally, you should have cluster-admin permissions or equivalent to to install software and manage resources in all clusters in the namespace.
Additionally, you should have cluster-admin permissions or equivalent to to install software and manage resources in all clusters in the namespace.

(Link cluster-admin to kubernetes documentation, along with the other items like the Kubectl tool.)

Processed reviwer edits
@dprotaso
Copy link
Member

dprotaso commented Oct 8, 2025

With the other PR merged are any changes in this PR still necessary?

@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 8, 2025
@knative-prow-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Edits per repurposing
@knative-prow knative-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants