This PR fixes bad links found in the contribute section, identified via:
```
./scripts/linkchecker.py -l zh -f /docs/contribute/**/*.md
```
Fix Summary:
Bad links pointing nowhere: 23
Links which should point to localized pages: 28
Links which should avoid redirections: 5
Unsafe links that use HTTP: 6
kubectl run starting from 1.18 is creating only Pods and there is no option to
create any other resource. Users should be using kubectl create
commands instead. This update the documentation in all those places
where kubectl create should be used instead or changes description to
reflect the situation.
* Added hyperlink in line 19
Added a hyperlink https://github.com/kubernetes/website/contribute at line 19 (Improve existing content ) which points to "good first issue," available.
This will help new contributors to make their first contribution.
* Update _index.md
* Update content/en/docs/contribute/_index.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Jim Angel <jimangel@users.noreply.github.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
* Advising single localization pull requests
Advise contributors to limit pull requests to a single localization #20411
* Update content/en/docs/contribute/localization.md
Accept suggested code review changes
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
I followed the process for generating docs, but encountered and fixed some problems along the way due to incorrect commands in the documentation:
* Fixed incorrect go get source for `github.com/kubernetes-sigs/reference-docs`
* Fixed syntax error in shell commands by changing `$(GOPATH)` to `$GOPATH`
* Fixed wrong variable name, changed `WEB_ROOT` to `K8S_WEBROOT` to match what Makefile expects
* Update content in intermediate.md
Replaced “If your feature is moving out of Alpha, make sure to remove it from that file.” with “If your feature is moving to Beta or to General Availability, update the feature gates file.”
* Revised update intermediate.md
Preserved the wrapping per Tim's suggestion
* 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.
* Update documentation to reflect Go 1.13 dependency for Kubernetes 1.17+
* Rephrased required Golang version
* Updated french translation to match English Golang version
* feat: graduate TaintNodesByCondition to GA (#17073)
* Promote StartupProbe to beta (enabled by default). (#17164)
* Watch bookmarks to GA (#17026)
* feat: graduate ScheduleDaemonSetPods to GA (#17350)
* Update Docker installation instructions (#17405)
* Use exact version numbers for installing Docker in Ubuntu (#17428)
* Move CSIMigration and CSIMigrationGCE to Beta in Kubernetes v1.17 (#17478)
* Promote NodeLease feature to GA (#17189)
* Update docs for csi topology ga (#17408)
* Update RunAsUsername to beta (#17460)
* doc:Update RunAsUsername to beta
* doc: update samples - kubernetes.io/os is no longer beta
* Updating based on review feedback
* Promote Node-specific volume limits to GA (#17432)
* Promote PodShareProcessNamespace to stable (#17192)
* Promote PodShareProcessNamespace to stable
* Add for_k8s_version to feature-state label
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Readd version-check to shareProcessNamespace task
* Update service load balancer finalizer doc for GA (#17438)
* Update Topology Manager docs (#17451)
* Added information on how device plugins can take advantage
of Topology Manager
* Updated the Topology Manager documentation to include additionalinformation and update some out of date sections
* Fix broken Topology Manager link (#17746)
Part of What's Next Device Plugin section
* Update CRD defaulting docs for GA (#17450)
* Add documentation for VolumeSnapshot Beta (#17233)
* Updating EndpointSlice documentation for beta release in 1.17 (#17411)
* (docs/dualstack): v1.17 updates (#17457)
* Add placehold doc updates for dualstack in 1.17
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Add Downward API and /etc/hosts Pod IP validation
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* remove addressed known issue via k/k pr 85246
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Remove known issue and add flag as part of k/k 79993
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* remove follow up placeholders
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update verbiage
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Make IP addressing consistent throughout the task
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update to status.podIPs
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update content/en/docs/tasks/network/validate-dual-stack.md
Use set instead of env
Co-Authored-By: Khaled Henidak (Kal) <khnidk@outlook.com>
* add topology.kubernetes.io/zone, topology.kubernetes.io/region and node.kubernetes.io/instance-type labels to docs (#17498)
Signed-off-by: Andrew Sy Kim <kiman@vmware.com>
* Service topology alpha documentation (#17459)
* Update list of feature flags for in-tree plugins migrated to CSI (#17533)
Signed-off-by: Deep Debroy <ddebroy@docker.com>
* Update Node concept for TaintNodesByCondition going GA (#17577)
* feat: graduate ResourceQuotaScopeSelectors to GA in 1.17 (#17554)
* kubeadm: update the upgrade documentation for 1.17 (#17587)
* doc: Simplify Windows deployments with RuntimeClass (#16697)
* doc: Simplify Windows deployments with RuntimeClass
* Updating on review feedback
* doc: Adding windows-build label from enhancement 1301
* update doc for kubelet option --reserved-cpus (#17648)
* feat: update TaintNodesByCondition in feature gates table (#17377)
* Update docs for v1 resource quota configuration (#17547)
* AdmissionConfiguration v1 (#17548)
* Update WebhookAdmissionConfiguration examples (#17549)
* Update AWS EBS Migration Feature state (#16126)
* Add resource version section to api-concepts documentation (#16910)
* Add Resource Version semantics section to api concepts
* Clarify risks of going back in time, add details about compaction and watch cache sizes
* Apply suggestions from liggitt
Co-Authored-By: Jordan Liggitt <jordan@liggitt.net>
* remove pesudocode, apply feedback
* Fix typo
* Clarify equality rules
* Cleanup kubectl generators docs (#17609)
* Write ReplicationController without a space
* Drop mentioning unsupported cluster versions
* Fix capitalization for “API group”
* Tweak wording
* Avoid using deprecated generator in example
* add Antrea description in dev-1.17 (#17919)
* Promote VolumeSubpathEnvExpansion to GA
* Reference Documentation for the Kubernetes API for 1.17 (#18019)
* Update feature-gates.md (#18033)
* Reference Documentation for kubectl Commands for 1.17 (#18017)
* Update for v1.17 (#18034)
* Update config.toml(release-1.17) for 1.17 (#18031)
* update style guide for styling component names
- Attempt to outline style conventions for components
and component tools
- Interested in comments and feedback
* update style examples
* style edits
- removed code style for components not cmd tools
- added style suggestion for namespaces
- cleaned up a few stray spaces
- renamed docs/reference/kubernetes-api/index.md
- added weight to files in docs/reference/kubernetes-api
- attempt to clean up labels-annotations-taints.md
- updated _redirects file
* Change the full link in the document to an inline link.
grep -r "https \: \ / \ / kubernetes \ .io" content/en/docs
Changed to inline link except the following list.
- URLs are mentioned directly in the body
- release note
- url to blog
- url to community
- Url to be redirected
* Apply suggestions from code review
Co-Authored-By: June Yi <june.yi@samsung.com>
-Update to use argparse.ArgumentParser() for command line args
-Use tempfile library to create tmp work directory
-Remove shutil.rmtree because it was throwing permission errors and
not deleting the directory. Also no longer needed after switching
to tempfile.
-Enchance error handling
-Add check for Go installation
-Enhance check for PyYAML installation
-Change deprecated PyYAML load function to full_load
-Add comments at top of file
-Modify to comply with PEP8
-Update kubernetes-components.md with software versions to match script
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Update kubernetes-components.md with software versions.
Move content from README to kubernetes-components to avoid duplication.
Be listed in the `kubernetes/website/data/reference.yml` file
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Enhance to emphasize that triagers should add a priority to each
issue.
Add Learn about Prow section
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
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 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
Anna Jung
Brad Topol
Bob Killen
Casie Oxford
TAKAHASHI Shuuji
Kubernetes Prow Robot
Tim Bannister
Aashu Anshuman
Jim Angel
Qiming Teng
Jim Angel
zacharysarah
Lauri Apple
Jorge O. Castro
SataQiu
Celeste Horgan
Jerry Park
Karen Bradshaw
joelbyronbarker
Maciej Szulik
makocchi-git
Roy Lenferink
Heena Khan
Krishan Sharma
Davanum Srinivas
Kim McMahon
Ilja
mikejoh
Senthil Kumar Sekar
Zach Corleissen
Brian Pursley
inductor
Jacky Wu
Sujay Pillai
divya-mohan0209
vishakha
Anshu Prateek
Jie Shen
Sharjeel Aziz
Xiang Dai
Thomas
Damini Satya
chentanjun
aimeeu
Yuk, Yongsu
PingWang
Abhishek Mane
Roy Hvaara
Praveen Sastry
savitharaghunathan
Kaitlyn Barnard
Max Kaminskiy
Jared
Ellen Mei
zhangqx2010
Rajakavitha1
codyc
Luc Perkins
June Yi
Franklin Yu
Yang Li
shavidissa
Rael Garcia
chenrui
Danny Berger
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
Tim Fogarty
alex-libre
Justin Clift
Cody Clark
CaoShuFeng
AdamDang