-
Notifications
You must be signed in to change notification settings - Fork 88
Add versioning to the docs #869
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
base: main
Are you sure you want to change the base?
Conversation
the previous /images/ does not work when the content is versioned
otherwise, it did not appear because its in the same header_topic element that was getting hidden
in case release doesn't have v or has extra info after patch
❌ Deploy Preview for gateway-api-inference-extension failed. Why did it fail? →
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: artberger 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 |
Welcome @artberger! |
Hi @artberger. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
Addresses #422
Working locally based off my fork in Netlify here: https://app.netlify.com/projects/adb-inf-extension/deploys
The docs are versioned using a MkDocs plug-in called
mike
(GitHub project here). They are put on adocs
branch.Project updates that would be needed
docs
branchYou have to do a one-time creation of a clean
docs
branch so that themike
tool can put the versioned docs on that branch.Locally, I used the following commands to do that:
Netlify updates
In my Netlify account, I have the following settings. This way, Netlify builds based on changes to the
docs
branch. You don't need a specific build command because the HTML files are already built to thedocs
branch through themike
versioning.Build & Deploy > Build settings
Build & Deploy > Branches and deploy contexts