Configure docs.helm.sh to pull content from kubernetes/helm #47
Conversation
Removes the local copy of the /docs folder, and instead uses the latest /docs folder from https://github.com/kubernetes/helm:master to generate the docs.helm.sh website, to ensure the latest contents are published. The gulp build process will fetch github.com/kubernetes/helm and clone the contents into /source, then Hugo will build the site from the markdown content found within /source/docs.
|
Some issues to resolve before review:
|
* updates the sidebar menu with urls and category groupings that correspond to the latest docs content from kubernetes/helm repo * inject the name of each file as an alias (toml) to create redirects so that `/page.md` will reroute to `/#page` * find and replace to fix broken urls * find and replace to fix image paths * use runSequence to ensure gulp tasks wait for each other to fully complete (where necessary) and run in order
|
@flynnduism sure thing! In addition to code review, deploying site off this branch somewhere locally and checking it out probably be the ticket? |
|
@vdice yeah that would be awesome! |
|
@vdice staging updated with working webfonts: http://docs-helm-sh.staging.deis.com/ To get them working here, Hugo's config.toml required the |
docs/config.toml
Outdated
| publishdir = "app" | ||
|
|
||
| [params] | ||
| title = "Helm Docs" | ||
| author = "Ronan Flynn-Curran" | ||
| description = "Documentation for Helm - The Kubernetes Package Manager." | ||
|
|
||
| canonifyURLs = "false" | ||
| relativeURLs = "true" | ||
| canonifyURLs = "true" |
There was a problem hiding this comment.
curious about the change to flip this and the relativeURLs values from previous?
|
|
||
| [[menu.main]] | ||
| name = "Home" | ||
| url = "https://docs.helm.sh" |
There was a problem hiding this comment.
perhaps related to comment above -- are we sure we want to hardcode the url here? (as opposed to it being relative/based on environment where deployed)
There was a problem hiding this comment.
Opened this as a follow-up issue (#49).
Hugo makes it a bit tricky, but it should be doable.
During development, I had changed these values whilst debugging Hugo and forgotten to revert them back to the recommended settings.
This modifies the
gulpbuild process, to import and index the latest docs content from github.com/kubernetes/helm, and use it to generate the docs.helm.sh website.Why?
make docsis ran during development--
How?
Updates gulp task with gulp-git
Replaces local docs content with the latest copy from kubernetes/helm
Indexes the site content locally, instead of requiring the source to use a Hugo-friendly format
(i.e. stop depending on the inclusion of TOML metadata)
this is handled locally by: