Repository navigation
Migrate documentation from MkDocs to Docsy - #4734
Conversation
|
Hi @iromanycheva-eng. 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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
f40ad5c to
5e1c8a3
Compare
791ced0 to
39ab797
Compare
|
Looks like all moved or renamed files are added as new in this PR. Can we mark them as moved instead? |
39ab797 to
7e67079
Compare
7e67079 to
2e331d5
Compare
|
This looks really great! A couple of things that I think could be better though: The Overview style pages would ideally be the landing page for each of the headings, as they are today, rather than the table of contents that they are in the current state. So:
When navigating GEPs, the table of contents on the left disappears when you get down to the actual GEP itself. Ideally this would at least show the parent, or auto-expand the current section or something. Aside from that, I think this is looking pretty close. Shockingly so, well done. |
|
/ok-to-test |
e3facf6 to
e55be90
Compare
| id = "G-JPP6RFM2BP" | ||
|
|
||
| # Allow Hugo to download fonts via resources.GetRemote | ||
| [security] |
There was a problem hiding this comment.
is this really necessary? I can't see this same directive on https://github.com/kubernetes/website/blob/main/hugo.toml
There was a problem hiding this comment.
are you asking about gtag or security ? If gtag, yes, it is. That's how we track gw website metrics.
There was a problem hiding this comment.
security, specifically Hugo to Download fonts:
[security.http]
mediaTypes = ['(?i)^font/.*$', '(?i)^application/font-woff$']
|
@iromanycheva-eng first of all, thanks for the whole work here!! This is great! Some findings:
Not now, but eventually we can update docsy to 0.15 and get https://www.docsy.dev/blog/2026/0.15.0/#doc-rooted-sites for free :D (and maybe we can start considering a versioned docs per release as well) |
a35c019 to
d6b9621
Compare
79ce654 to
4b71aaf
Compare
@rikatz , thank you for all the comments. Really appreciate such a thorough review.
|
Redirect section headers to the first subtree content page instead of the TOC. Include breadcrumbs in Geps to enhance user navigation.
Also upgrade version of hugo and docsy
Fix some rendering and icons
Delete the github references. Fix some rendering and scripts.
Add go and npm dependencies to the dependabot. Refactor geps pages parsing.
Makefile: Use Docker for Hugo CI: Install Hugo manually instead of using a 3rd party action UI: Support dark mode for code blocks and make TOC collapsible Generator: Strip excludeFromCRD tags from generated spec files.
|
/lgtm Thanks @iromanycheva-eng ! @bexxmodd as a followup we need to incorporate https://github.com/kubernetes-sigs/gateway-api/pull/4848/changes again |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: iromanycheva-eng, rikatz, youngnick The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/hold cancel |
What type of PR is this?
/kind documentation
Optionally add one or more of the following kinds if applicable:
What this PR does / why we need it:
We need to migrate documentation from MkDocs to Docsy because there is a better support for google analytics. Besides Docsy is a recommended theme for kubernetes sites.
Which issue(s) this PR fixes:
Fixes #4729
Does this PR introduce a user-facing change?: