Commit Graph

138 Commits (3d63002fa36d970c5a8708dcee000fd6e623517e)

Author SHA1 Message Date
Tim Bannister e836c83b4a
Tidy “Participating in SIG Docs” (#19151)
- Fix broken link
- Move localization work from Reviewers group to Anyone
- Minor other tidying
2020-02-17 10:21:29 -08:00
Jim Angel a48b34474a
updating agenda meeting link (#19087) 2020-02-12 03:28:52 -08:00
vishakha 4c3a5c6f5f
Adding contribution best practice in contribute docs (#18059) 2020-02-08 06:17:52 -08:00
Celeste Horgan 9bcde5cd94
Remove duplicate content: Roles & Responsibilities (#18920)
* Remove duplicate content: Roles & Responsibilities

Signed-off-by: Celeste <celeste@cncf.io>
Address feedback

Signed-off-by: Celeste <celeste@cncf.io>

* Apply suggestions from review

Co-Authored-By: Zach Corleissen <zacharysarah@users.noreply.github.com>

* Link to contribution guidelines

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Address PR feedback

Signed-off-by: Celeste Horgan <celeste@cncf.io>

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
2020-02-07 11:33:45 -08:00
Karen Bradshaw 121076085c
updating contrib for ref docs (#18787)
more cleanup
2020-02-06 13:53:25 -08:00
Tim Bannister d0f6d60ec9
Revise pull request template (#18744)
* 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.
2020-02-03 23:25:26 -08:00
Tim Bannister 44b7de8749 Fix references to sig-docs-l10n-admins (#18661) 2020-01-28 11:57:41 -08:00
Anshu Prateek 040df41846 change escaped chars to markdown (#18858)
Helps to keep doc clean for long term
2020-01-28 02:51:40 -08:00
Jie Shen fb788cfba3 Fix typo in en/docs/contribute/style/content-guilde.md (#18862) 2020-01-27 01:35:05 -08:00
Sharjeel Aziz 2d410f35c5 Fix for a typo (#18822) 2020-01-24 08:30:32 -08:00
Xiang Dai f21f4b2257 Fix en language misspell (#18201)
* fix misspell

Signed-off-by: Xiang Dai <764524258@qq.com>

* clean white noise

Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 06:49:32 -08:00
Thomas 6d9188692a Update documentation to reflect Go 1.13 dependency for Kubernetes 1.17+ (#18171)
* Update documentation to reflect Go 1.13 dependency for Kubernetes 1.17+

* Rephrased required Golang version

* Updated french translation to match English Golang version
2019-12-16 15:33:40 -08:00
Damini Satya dff2f7b960 Official 1.17 Release Docs (#18011)
* 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)
2019-12-09 16:11:29 -08:00
Karen Bradshaw 249f88c64e update style guide for styling component names (#17588)
* 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
2019-12-02 02:21:04 -08:00
Jim Angel c498580523 adding in search link (#17640) 2019-11-21 13:37:29 -08:00
chentanjun 9335df5d49 fix-up the broken link (#17601) 2019-11-17 17:35:42 -08:00
aimeeu 99895de868 Update work from a local clone section (#16748)
Add content based on Slack thread
https://kubernetes.slack.com/archives/C1TU9EB9S/p1570736679005700

Change -f to --force-with-lease
Simplified wording

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-27 10:11:24 -07:00
Karen Bradshaw f29d3153eb rename reference/kubernetes-api/index (#16947)
- 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
2019-10-23 08:48:16 -07:00
Zach Corleissen b894856e8e Update how to run Hugo locally (#16982) 2019-10-23 08:26:19 -07:00
Yuk, Yongsu d437e8c6bc en: Change the full link in the document to an inline link. (#17057)
* 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>
2019-10-23 06:20:14 -07:00
aimeeu 04127a3acb Update script for Python3, PyYAML 5.1.2 (#17127)
-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>
2019-10-22 14:04:18 -07:00
aimeeu b1bd43f9d7 Update how to use the update-imported-docs tool (#16777)
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>
2019-10-14 16:19:52 -07:00
aimeeu cf390493af Add best practices to Review docs pull requests (#16770)
Simply and reduce language in bullet points

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-14 16:13:50 -07:00
PingWang 74397dd65f Add the -n for pod in kubectl command (#16798)
Signed-off-by: PingWang <wang.ping5@zte.com.cn>

Add instructions in kubectl command

Signed-off-by: PingWang <wang.ping5@zte.com.cn>

update

Signed-off-by: PingWang <wang.ping5@zte.com.cn>
2019-10-11 18:28:39 -07:00
Abhishek Mane a909352ac6 feature added for issue #16771 (#16802)
* feature added for issue #16771

* Update intermediate.md
2019-10-11 15:10:04 -07:00
Karen Bradshaw 04476d0c3d fix spelling in contribute/start (#16767) 2019-10-11 14:54:04 -07:00
PingWang d99bfecfa9 Correct the #sig-docs URL (#16763)
Signed-off-by: PingWang <wang.ping5@zte.com.cn>
2019-10-09 06:09:51 -07:00
Roy Hvaara b1cc4d982b Fix broken link to Documentation style overview from Contribute page (#16667) 2019-10-02 13:58:08 -07:00
Jim Angel 0044acb69a reflecting k8s-sig migration (#16632) 2019-10-02 11:46:07 -07:00
aimeeu bd7308274e Update reference-docs repo (#16622)
reference-docs moved from kubernetes-incubator to kubernetes-sigs

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-09-30 12:42:46 -07:00
aimeeu e2da611c77 Enhance Triage and categorize issues section (#16295)
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>
2019-09-25 08:54:01 -07:00
aimeeu d80ab90cdb Add references to Content guide alongside Style guide (#16101)
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>
2019-09-25 08:52:01 -07:00
Karen Bradshaw 444ef3486e add processing of kubectl cmd links (#16529)
- add processing of kubectl links in update-imported-docs.
- update component reference generation guide.
- For more information, see issue #16454.
2019-09-24 00:59:25 -07:00
Praveen Sastry b2d803d71e Rename `Flexvolume` to `FlexVolume` in docs (#16333) 2019-09-12 09:42:27 -07:00
savitharaghunathan 8f2d392fb5 Updating style.md and write-new-topic.md with markdowns (#16190) 2019-09-11 18:08:38 -07:00
Kaitlyn Barnard 9962db5ac3 Swap out link for Kubernetes blog submission form (#16089) 2019-09-04 20:16:51 -07:00
aimeeu c9d9e1be14 Add Content Guide to clarify allowed content (#15892)
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>
2019-08-26 17:56:39 -07:00
sNathan13 8c4a2bf73c Adding PR review request etiquette (#15972) 2019-08-20 19:27:17 -07:00
Max Kaminskiy 7fc8050389 Note to limit changes in PR to one language (#15773)
* Updated Start Contributing docs asking to limit changes to one
language in each PR.

* Moved note about one language per PR to end of step 5.
2019-08-15 20:30:33 -07:00
Jared a02fea5330
Update link 2019-08-13 09:20:16 -07:00
Jared efed54c79a
Fixed broken link 2019-08-13 09:18:43 -07:00
aimeeu 8eba965dff Update Participating in SIG Docs and Submit a PR (#15697)
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
2019-08-07 14:46:37 -07:00
aimeeu efa8bf1c37 Update link to Docs SIG agenda document (#15703)
The basics about our docs/Style guidelines:  "add it to the agenda" updated the link to point to 2019 agenda document
2019-08-06 11:43:56 -07:00
Zach Corleissen 9591ca0957 Tiny typo fix (#15579) 2019-07-30 08:50:53 -07:00
Zach Corleissen ce8fc52fef Add closure guidelines (#15261)
Add close command

Add a note about fejta-bot

Feedback from kbhawkey
2019-07-14 05:17:03 -07:00
Karen Bradshaw 997242c871 clean up label comments (#15397) 2019-07-13 11:03:04 -07:00
Zach Corleissen 0e540e8dcb Update contribution guidelines for approvers (#15385) 2019-07-12 16:25:04 -07:00
Tim Bannister 3ca1955a13 Add “CNCF” to glossary (#14537)
* Add glossary entry for CNCF

* Use CNCF glossary entry
2019-07-11 18:03:07 -07:00
Ellen Mei ec61bf6c84 machine-generated translations need human review (#15381) 2019-07-11 11:13:06 -07:00
Karen Bradshaw 48e68a9eb5 Update api reference contrib doc (#15114)
* 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
2019-07-06 21:00:34 -07:00