* Revise pull request template
* Reference compiled docs in PR template
Refer readers to https://k8s.io/contribute/start/
This keeps the template short, and it lets Hugo use templating for
the current version.
Add references to the Content guide where the Style guide was
mentioned.
Update the Contribute page (_index.md)
Make Style and Content linkable everywhere
Changed bullet list to numbered list in Content Guide to make referring
to sections easier.
Reverted change to bullet list - beyond scope of this PR
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add new section for content guidelines
Add table of examples of what is and is not allowed
Add examples of links to Linux Academy courses based on discussion
during the Aug 20 SIG Docs meeting.
Remove example table and reformat based on feedback
Move content guide to its own page
Update existing pages to mention new Content Guide page
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add hyperlink to 'communicate' in Participating in SIG Docs section.
Hyperlink points to Participating in SIG Docs discussions section further down the page.
Add info to Submit a pull request bullet 5 about putting fixes #<issue_number>
or closes #<issue_number> to the PR description so GitHub will automatically close the issue
* Update PR template for 1.13 release
Also updates links to documentation for submitting PRs
* Update contributing docs for new branch strategy
Branches for upcoming releases are now dev-X.Y instead of
release-X.Y
* WIP - rework update imported docs
* Rework tool/doc for updating reference docs
This PR reimplement the reference docs generator in Python and fixes
some outdated docs and data:
- Do docs import using Python because the GoLang version of tool has
some following drawbacks:
* its not convenient for handling YAML config files
* it has to be compiled to binaries to run on different platforms
* for every tiny changes you need to compile a new version and check in
- The reference docs we use in website are actually not coming directly
from `kubernetes/kubernetes`. Most of them come from the `reference-docs`
project. The configuration files are thus changed to avoid confusion.
- We have changed the location of generated docs so the default configuration
files and the docs are updated.
* Reorganize docs contrib guide
* Address first round of feedback from Brad, Jared
* Standardize on 'SIG Docs'
* Address more feedback
* Rewrites to participating.md
* Tweak navigation titles
* Document PR Wrangler
* Document SIG Docs chairperson
* Fix codeblock that shows how to use <codenew>
It was being interpreted as a Hugo shortcode.