Skip to content

Conversation

evankanderson
Copy link
Member

Fixes #6378

Proposed Changes

  • In Attempt to rebuild docs build process, inspired by #6319 #6371, we performed a bunch of mv operations in the build.sh script for the current development revision. This PR changes that to move these directories under a docs/ subdirectory for the development version of the documentation. (I'd also be open to naming the directory development, which might spare one additional relocation in the script.)
  • With docs/docs/README.md now empty, moves the technical overview to that location, and cleans up (removes / relocates) the other concepts to the appropriate serving/eventing component. TBD: updating the navigation to put the overview at "Docs".
  • Adds a doc_base parameter to hint to the edit button where technical docs were located given the directory move over revision releases.
  • Updates build.sh to be able to handle future versions flexibly by keying off this move for build steps.
  • Cleans up some references and links affected by this move.

Copy link

netlify bot commented Sep 19, 2025

Deploy Preview for knative ready!

Name Link
🔨 Latest commit 9339116
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/68d2d4f55ddf7d000880c11a
😎 Deploy Preview https://deploy-preview-6398--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 19, 2025
@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 19, 2025
@knative-prow knative-prow bot requested review from Leo6Leo and nainaz September 19, 2025 19:33
@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 19, 2025
Copy link

knative-prow bot commented Sep 19, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

@knative-prow-robot knative-prow-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 19, 2025
@evankanderson evankanderson changed the title Follow-on to search fixes: fix editing Fix edit page links, move technical docs under sub-heading Sep 19, 2025
@evankanderson
Copy link
Member Author

Note that the pre-release version links won't work and will look like:

https://github.com/knative/docs/edit/main/docs/docs/serving/README.md

This is because those docs will be moved to that location by this PR.

Copy link

knative-prow bot commented Sep 19, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

Copy link

knative-prow bot commented Sep 19, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

@evankanderson
Copy link
Member Author

/hold

In case there are PRs that want to merge first

@knative-prow knative-prow bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 19, 2025
Copy link

knative-prow bot commented Sep 19, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

Copy link

knative-prow bot commented Sep 20, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

@evankanderson
Copy link
Member Author

/hold cancel

@knative-prow knative-prow bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 22, 2025
@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 22, 2025
Copy link

knative-prow bot commented Sep 23, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

@knative-prow-robot knative-prow-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 23, 2025
Copy link
Member Author

@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 PR is ready for review

@evankanderson
Copy link
Member Author

/assign @Cali0707 @dprotaso

Copy link

knative-prow bot commented Sep 23, 2025

There are empty aliases in OWNER_ALIASES, cleanup is advised.

@knative-prow knative-prow bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 23, 2025
@dprotaso
Copy link
Member

/lgtm
/approve

Is there an automated way to update other PRs? Or can you leave a comment on them?

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

knative-prow bot commented Sep 23, 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 ba2c938 into knative:main Sep 23, 2025
27 of 35 checks passed
@evankanderson
Copy link
Member Author

I can leave a comment on them, and they should have conflicts.

@dprotaso
Copy link
Member

/cherry-pick release-1.19

@dprotaso
Copy link
Member

I'm thinking we should cherry pick so that way any future changes we want to cherry-pick will be possible to be done using automation.

@knative-prow-robot
Copy link
Contributor

@dprotaso: Failed to get PR patch from GitHub. This PR will need to be manually cherrypicked.

Error messagestatus code 406 not one of [200], body: {"message":"Sorry, the diff exceeded the maximum number of files (300). Consider using 'List pull requests files' API or locally cloning the repository instead.","errors":[{"resource":"PullRequest","field":"diff","code":"too_large"}],"documentation_url":"https://docs.github.com/rest/pulls/pulls#list-pull-requests-files","status":"406"}

In response to this:

/cherry-pick release-1.19

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.

dprotaso pushed a commit to dprotaso/knative-docs that referenced this pull request Sep 23, 2025
)

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

* Fix edit links by moving docs content under a dedicated subdirectory
@evankanderson
Copy link
Member Author

I'll work on cherrypicking this and necessary processing changes to 1.19 tomorrow.

evankanderson added a commit to evankanderson/docs that referenced this pull request Sep 25, 2025
)

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

* Fix edit links by moving docs content under a dedicated subdirectory
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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Edit Button on Pages 404s

4 participants