Skip to content

Conversation

evankanderson
Copy link
Member

Related to #6305 -- today, the "Install" section is the third section in the docs (after "Overview" and "Tutorial"). This suggests that most of the audience should read that next, but 90% of the content only applies to administrators.

Proposed Changes

  • Moves "Install" topic to an "Administration" section.
  • Removes install/quickstart-install in favor of getting-started/quickstart-install, with almost exactly the same content.
  • Removes install/install-kn in favor of client/install-kn, with the same content
  • Cleans up some homepage content after checking the homepage nav and noticing that the primary CTA button styling actually made the secondary button more visible. I ended up adding some CSS selectors because the home.css interacts with the material theme CSS and sometimes needs to be more specific.

Copy link

netlify bot commented Sep 24, 2025

Deploy Preview for knative ready!

Name Link
🔨 Latest commit dd7efc9
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/68d4852766e81b0008b4431f
😎 Deploy Preview https://deploy-preview-6403--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.

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 24, 2025
@knative-prow knative-prow bot requested review from Leo6Leo and matzew September 24, 2025 23:56
@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 24, 2025
Comment on lines 24 to +25
href="{{ 'docs/install/' | url }}"
class="md-button white md-button--secondary"
class="md-button"
Copy link
Member

Choose a reason for hiding this comment

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

When should we update this href to the newer location?

@dprotaso
Copy link
Member

/lgtm
/approve

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

knative-prow bot commented Sep 25, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dprotaso, evankanderson

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:
  • OWNERS [dprotaso,evankanderson]

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 merged commit d8ca713 into knative:main Sep 25, 2025
23 of 24 checks passed
evankanderson added a commit to evankanderson/docs that referenced this pull request Sep 25, 2025
knative-prow bot pushed a commit that referenced this pull request Sep 25, 2025
* Phase 1: Adding documentation metadata tags (#6274)

* Add metadata tags for documentation

* Add classification for about 2/3rds of docs (func + eventing)

* Add classification for remainder of docs (serving+install)

* Add mermaid support (#6327)

* Publish threat model in documentation (#6263)

* Publish threat model in documentation

* Separate security contents a bit more, update link to threat model, update nav

* Add a section on supply chain and SBOM/SLSA mitigation

* Update threat model with feedback from David Hadas

* Update introduction with content from davidhadas, add sections on controller and webhook functionality and update targets of threats

* content tab fixes, added success output for kn func (#6367)

* Add dry run section and take out old feature flag in serving (#6366)

* add dry run section

* drop mention of old feature flag

* fix casing on nav

* update docs to be more clear and include inline example

---------

Co-authored-by: Dave Protasowski <dprotaso@gmail.com>

* Attempt to rebuild docs build process, inspired by #6319 (#6371)

* Attempt to rebuild docs build process

* Use a more modern python version

* Fix strict verify, hide versions on unversioned pages

* Fix search with mkdocs typescript patches (vendored). (#6392)

Hopefully, this can be fixed upstream via PR shortly.

* Installation Doc Updates (#6395)

* Installation Doc Updates

Improve installation guidance

* Formatting fix

* Update docs/install/README.md

link fix

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

* Update docs/install/README.md

link fix

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

* link fix and table update

More writing

* Update README.md

Misc edits

* Update README.md

Minor edits

* Adding install-kn to PR

Consolidating CLI installations into this this topic.

* Update install-kn.md

Changing red bug alert to important
The old syntax was:
??? bug "Having issues upgrading `kn` to Homebrew?"

* Update install-kn (snippet)

Removed alert formatting

* Added quickstart-install.md

Various edits

* Fixes and reviewed edits

Made Evan suggestions, table column test, spelling fixes

* Update quickstart-install.md

link fix

* Update README.md

Replaced the table with a bulleted list approach.

* Update README.md

Put back the table

* Added serving and eventing install topics

Updated topics per effort - consolidating guidance

* Link fixes

* Made Evan's edits

* Various updates

All files added for this PR.

* Link fix

* Formatting fixes

* Formatting and consistency fix

* Update docs/install/operator/knative-with-operator-cli.md

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

* Update docs/client/install-kn.md

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

---------

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

* Fix edit page links, move technical docs under sub-heading (#6398)

* Fix edit links by moving docs content under a dedicated subdirectory

* Fix edit links by moving docs content under a dedicated subdirectory

* Add High availability documentation section for eventing (#6401)

I have copy-pasted from the Knative Serving documentation page the block as I found it missing when configuring it.

* Update proc-running-function.md (#6400)

Undo separeate kn func output for invoke

* Add a note that Apache Kafka is required to use EKB (#6404)

* Move install docs to administration (#6403)

* Fix trailing newline complaints

* Fix redirects from #6398

---------

Co-authored-by: Bruce Hamilton <scarlettbernique@gmail.com>
Co-authored-by: Alexander-Kita <Alexander.Kita@ibm.com>
Co-authored-by: Dave Protasowski <dprotaso@gmail.com>
Co-authored-by: Aurélien Joga <aurelienjoga+ajoga@gmail.com>
Co-authored-by: Christoph Stäbler <cstabler@redhat.com>
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.

2 participants