-
Notifications
You must be signed in to change notification settings - Fork 15k
Revise the Kubernetes website to use Docsy #20874
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
Revise the Kubernetes website to use Docsy #20874
Conversation
Welcome @aidanranney! |
Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA. It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.
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/test-infra repository. I understand the commands that are listed here. |
@aidanranney 👋 Thanks for opening a pull request! In order for us to accept the PR, you'll need to sign the contributor license agreement. |
Netlify is throwing a build error:
That's the error Hugo throws for a site version pre-0.60.0. We'll need to merge #19907 before this PR's preview builds successfully. |
I think we can tackle the couple obvious defects and maybe @bep could help with a conversation script. If we get it passable along with majority of content legible, maybe we merge and open issues on top? Would be a good convo for the weekly meeting. |
Thanks @zacharysarah! I've passed the license agreement along to Troy to sign up the organization. |
algolia_docsearch = false | ||
|
||
# Enable Lunr.js offline search | ||
offlineSearch = false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are all entries needed in the fields, css
and js
? Referring specifically to custom-jekyll/tags
and "callouts"?
netlify.toml
Outdated
|
||
[context.production.environment] | ||
HUGO_BASEURL = "https://kubernetes.io/" | ||
HUGO_ENV = "production" | ||
HUGO_ENABLEGITINFO = "true" | ||
|
||
[context.deploy-preview] | ||
command = "make deploy-preview" | ||
command = "cd themes/docsy && git submodule update -f --init && cd ../.. && make deploy-preview" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to update docsy every time or is it better to control when to accept docsy updates?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ve been bit a few times by not pinning something to a specific version, and would like if we could do so here so we can have a guarantee of consistency. Otherwise we might have some hard to pin down bugs or results.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I missed this in my other review, but I recommend the same syntax here as elsewhere:
command = "cd themes/docsy && git submodule update -f --init && cd ../.. && make deploy-preview" | |
command = "git submodule update --init --recursive && make deploy-preview" |
@aidanranney 👋 Please rebase when you have a chance. We merged the dependencies blocking this PR from building on its own merits. |
1e932a2
to
057fe9a
Compare
The preview build for this PR still fails with the same error:
Eventually I figured out that netlify isn't loading the submodule properly. After some experimentation, I'm able to run the build locally. Here's how I did it: In my local repo, I ran: git remote add gearbox-built git@github.com:gearbox-built/website.git
git fetch --all
git checkout -b kubernetes-docsy gearbox-built/kubernetes-docsy
git rebase upstream/master Then I ran:
The usual TLDR: We need to add the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aidanranney Thanks for addressing feedback so far. Netlify is failing for submodule-related reasons, so I suggest some alternate syntax:
@aidanranney I updated the PR description again; I hope that's OK. |
/lgtm #20874 (review) seems relevant and worth addressing at some point. |
Hi @aidanranney . Here is what I found regarding the anchors on the page:
However, Also, does the |
Makefile contains the |
Let's aim to merge this at 12pm Pacific on Monday, 15 June. (aka tomorrow) @sftim Let's thread these PRs to merge shortly afterwards:
|
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: zacharysarah 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:
Approvers can indicate their approval by writing |
Good work @aidanranney ! |
Revise the Kubernetes website to use Docsy.
In order to base the Kubernetes Hugo site upon the Docsy theme, this site was originally built upon a fresh Hugo project with Docsy installed. This was necessary in order to achieve iterative successful Hugo builds. This PR represents the end result of those changes, applied against the master branch.
Fixes #14992
Fixes #21753
Staging site @ https://kubernetes-docsy-staging.netlify.app/