Removing archaic requirements for SIG Docs co-chairs. For the record, that I did not fully meet when becoming a co-chair a couple years ago. The current set of requirements hurt more than they help.
Boosting the contributor site up in Google rankings is a priority for the Kubernetes Upstream Marketing team: https://github.com/kubernetes/contributor-site/issues/202
Adding links here where appropriate:
- Contributor Cheatsheet
- kubernetes.dev itself
- contributor resources
Fix `Source files` section in localization document, and remove {{< release-branch >}} variable
due to `release-1.20` branch does not exist.
- improve sentence
- Fix latest branch for latest version
- Add description if latest branch does not exist
- Describe about master branch
- Apply suggestions from code review
- Unify `development branch` to` localization branch`
- Remove description for switching upstream branch
- Add description for switching upstream
- Also, add description for merging to master and new release branch.
Co-authored-by: Qiming Teng <tengqim@cn.ibm.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Seokho Son <shsongist@gmail.com>
The switch from:
$ make docker-serve
to:
$ make container-serve
is far enough in the past that everyone should have a current Makefile.
Also highlight the command to fetch and use submodules.
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>
Kubernetes Prow Robot
chrismetz09
Qiming Teng
Shivam Singhal
Jayesh Srivastava
Tim Bannister
Jim Angel
Kensei Nakada
Deepak Tripathy
Meha Bhalodiya
budhirajamadhav
RinkiyaKeDad
Siddhant Prateek Mahanayak
Rey Lejano
Chris Short
Siddhant Prateek
robotjellyzone
Philippe Martin
Jim Angel
yuswift
Abigail McCarthy
Martin Kanters
Peter Sutter
Rolfe Dlugy-Hegwer
zacharysarah
Nick Santos
Karen Bradshaw
Shu Muto
June Yi
Jordan Liggitt
Geoffrey Cline
Dan Roscigno
Anna Jung (VMware)
Celeste Horgan
Arhell
Qiming Teng
Anna Jung
Brad Topol
Bob Killen
Casie Oxford
TAKAHASHI Shuuji
Aashu Anshuman
Lauri Apple
Jorge O. Castro
SataQiu
Jerry Park
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