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 api reference contrib doc
See issue #14111
* updates to api ref contrib guide
* further updates to api ref contrib
* more updates api ref contrib
* [WIP] added accessibility guidelines to the style guide
Adopted the accessibility level A and AA guidelines to Markdown elements:
https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0¤tsidebar=%23col_overview&levels=aaa
We still need to define attributes for the front matter. See, https://github.com/kubernetes/website/issues/14286
I am yet to draft the guidelines for images and alt text.
* fixed the note
Update style-guide.md
Incorporated the changes suggested
Incorporated the changes suggested.
fixed the formatting issues in the table
fixed the spaces in the links section
fixed a space issue
fixed format issues in the link
added a11y guidelines to code section
removed a spacing issue
front matter guidelines best fit the using template section
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
incorporated the changes
incorporated the changes
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
title section for front matter guideline
updated the html characters
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update style-guide.md
Add meeting guidelines, graphic
Update embedded image
Use raw HTML for image link
Edit path
Indent list items
minor edits
Add line breaks for indentation
Add bolding
Add section for meetings
Feedback from jimangel
* Add Setting up the OWNERS files section
* Update OWNERS_ALIASES patch
* Replace owners.md link with go.k8s.io/owners
* Replace github.com/kubernetes link with git.k8s.io
* Update OWNERS_ALIASES to use git.k8s.io link
* Sort patch diff in alphabetical order
* Specify clearly what teams should be added
* Remove the passive voice
* Complete alphabetical order phrase
Plain language rocks
Remove an orphaned line
Remove note
Present tense rocks
Add repository
Feedback, round 1
Add team descriptions
Add Slack link
Feedback, part 2
Feedback from gochist
Remove link
* Revise guide for generating reference docs
This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.
* light copyedit
* more light copyedits
* fix note shortcode, lists
- fix note shortcode for use in lists
- add example in style guide
* add more items to list
* update warning, caution, minor tweaks
* more updates
* Blog Issue triage
SIG-Docs decided that we only maintain blog entires <1 year in age. Updating our triage guidelines to reflect this.
* Fix typo, link markup, two misplaced modifiers
- The intro section had repeated text on visiting the community page. Refactored this content.
- Minor changes to content.
- Added links to Slack and the SIG docs mailing list.
* Copy-edit based on the style guide
Made the following changes:
- Used present tense.
- Removed latin phrases
- {{< tab name=“Content File #1” include=“example1” />}} was not shown as code. Updated it.
- Copy-edited the description for include under Tabs.
* Updated the text based on the comments
The current document had a minor issue: " Ask for sponsorship in the #sig-docs channel on the Kubernetes Slack instance](https://kubernetes.slack.com) "
I am assuming you wanted to link #sig-docs channel on the Kubernetes Slack instance to https://kubernetes.slack.com. Therefore, corrected it.
* New link about Localizing Kubernetes Documentation
This commit adds a link about Localizing Kubernetes Documentation in
README.md's Contributing to the docs section.
Fixed : #10485, #10622
Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>
* Update l10n guide about adding l10n README files.
This commit adds a link process about the l10n README files in
localization.md.
Fixed : #10485, #10622
Signed-off-by: Claudia J. Kang <claudiajkang@gmail.com>
* 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
* Update localization guidelines for language labels
Continuing work
Continuing work
Continuing work
More work in progress
Add local OWNERS folders
Add an OWNERS file to Chinese
Remove shortcode for repos
Add Japanese
Alphabetize languages, change weights accordingly
More updates
Add Korean in Korean
Add English to languageName
Feedback from gochist
Move Chinese content from cn/ to zh/
Move OWNERS from cn/ to zh/
Resolve merge conflicts by updating from master
Add files back in to prep for resolution
After rebase on upstream/master, remove files
Review and update localization guidelines
Feedback from gochist, tnir, cstoku
Add a trailing newline to content/ja/OWNERS
Add a trailing newline to content/zh/OWNERS
Drop requirement for GH repo project
Clarify language about forks/branches
Edits and typos
Remove a shortcode specific to a multi-repo language setup
Update aliases and owners
Add explicit OWNERS for content/en
Migrate content from Chinese repo, update regex in config.toml
Remove untranslated strings
Add trailing newline to content/en/OWNERS
Add trailing newlines to OWNERS files
add Jaguar project description (#10433)
* add Jaguar project description
[Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight.
Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod.
* Minor newline tweak
blog post for azure vmss (#10538)
Add microk8s to pick-right-solution.md (#10542)
* Add microk8s to pick-right-solution.md
Microk8s is a single-command installation of upstream Kubernetes on any Linux and should be included in the list of local-machine solutions.
* capitalized Istio
Add microk8s to foundational.md (#10543)
* Add microk8s to foundational.md
Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster.
* Update foundational.md
Thank you for your suggestions! LMK if this works now?
* Rewrote first paragraph
And included a bullet list of features of microk8s
* Copyedit
fix typo (#10545)
Fix the kubectl subcommands links. (#10550)
Signed-off-by: William Zhang <warmchang@outlook.com>
Fix command issue (#10515)
Signed-off-by: mooncake <xcoder@tenxcloud.com>
remove imported community files per issue 10184 (#10501)
networking.md: Markdown fix (#10498)
Fix front matter, federation command-line tools (#10500)
Clean up glossary entry (#10399)
update slack link (#10536)
typo in StatefulSet docs (#10558)
fix discription about horizontal pod autoscale (#10557)
Remove redundant symbols (#10556)
Fix issue #10520 (#10554)
Signed-off-by: William Zhang <warmchang@outlook.com>
Update api-concepts.md (#10534)
Revert "Fix command issue (#10515)"
This reverts commit c02a7fb9f9.
Update memory-constraint-namespace.md (#10530)
update memory request to 100MiB corresponding the yaml content
Blog: Introducing Volume Snapshot Alpha for Kubernetes (#10562)
* blog post for azure vmss
* snapshot blog post
Resolve merge conflicts in OWNERS*
Minor typo fix (#10567)
Not sure what's supposed to be here, proposing removing it.
* Feedback from gochist
Tweaks to feedback
* Feedback from ClaudiaJKang
* Capitalized "Pod" in multiple locations
This style guide states to always capitalize Pod, but in the next section it was written in lowercase in a couple places. I've capitalized them.
* Capitalized two additional instances of "Pod" as recommended by @neolit123
* Add new Sass generation system
* Remove resources folder
* Add develop Sass command and sourcemaps
* Add Hugo version shortcode for use in docs
* Add OWNERS file to ./sass folder
* 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.
* Add instructions for staging site using Docker
Adds a condensed version of the instructions in the README to
the intermediate contribution page.
* Format code blocks
* Copyedit and update with escape characters
- Use escape characters for {{< toc >}}.
- Copyedit the content.
* Remove the {{< toc >}} reference
The template does not need a {{< toc >}} as the TOC will be generated by default. Therefore, removed this info from the doc.
* Copyedit the page
A few minor updates were made.
* Update conjuction
Three options. The first (original) was OK, the second (change in this PR) was ambiguous, the third is a bit clearer.
It was not clear what "Before you begin" meant and how it needs to be added only if the task or tutorial is version specific. Therefore, added this info in.
* Add info about requesting access
This includes how to get a sponsor, how to be a sponsor,
how to become a reviewer, approver, and website admin.
* Address feedback
* 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.
Jared
aimeeu
Zach Corleissen
Karen Bradshaw
Tim Bannister
Ellen Mei
zhangqx2010
Rajakavitha1
codyc
Luc Perkins
June Yi
Franklin Yu
Yang Li
shavidissa
Rael Garcia
chenrui
Danny Berger
Qiming
Shashank Patel
Rémy Léone
chenrui
Brandon Philips
Dani Comnea
Neha Yadav
Bill Mulligan
Misty Linville
Joseph Heck
Jake Crawford
Robin Rakowski
MengZeLee
Claudia J.Kang
SataQiu
Tim Fogarty
alex-libre
Justin Clift
Cody Clark
CaoShuFeng
AdamDang
Sam Foo
Julie Bruce