Commit Graph

163 Commits (486dd61f2bd040a52f1e44ec3c5a984040e6e932)

Author SHA1 Message Date
Celeste Horgan e0ae1338cd Correct links
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-05-12 13:58:32 -07:00
Jerry Park 19d45c8dd0 Fix issue with k8s.io/docs/contribute/advanced/ 2020-05-11 06:42:03 +09:00
Heena Khan 792c444926
Link to GitHub list of good first issues (#20196)
* 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>
2020-04-20 19:28:56 -07:00
Krishan Sharma f2839de743
Advising single localization pull requests (#20431)
* 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>
2020-04-20 12:03:40 -07:00
Davanum Srinivas 85e5002e44
We don't require DCO or git --signoff
not sure where this came from. cut-n-paste from somewhere else?
2020-04-18 18:16:11 -04:00
Kim McMahon a3d53d0f16
Update guidelines and link to submit a case study 2020-04-16 13:29:23 -06:00
Kubernetes Prow Robot d26096c8da
Merge pull request #18173 from jimangel/fix-release-info
fixing information about dev contrib
2020-04-14 07:54:12 -07:00
Ilja c9de7b6eae
Fix broken link 2020-04-14 08:22:06 +03:00
Ilja b8348ac7c3
Update _index.md 2020-04-14 07:56:03 +03:00
Ilja 4846167e7f
Fix link to new PR page 2020-04-14 07:53:08 +03:00
Jim Angel 00b106a744 fixing information about dev contrib 2020-04-13 12:19:03 -05:00
Kubernetes Prow Robot 7c8b2024c9
Merge pull request #20177 from senlog/patch-1
Update _index.md
2020-04-08 17:13:44 -07:00
mikejoh fce5bbabfc Fix broken links 2020-04-08 20:51:50 +02:00
Senthil Kumar Sekar cb4ad13b5e
Update _index.md
Typo correction.
2020-04-08 23:43:18 +05:30
Celeste Horgan f0cded013f Restructure to reduce duplication
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-04-07 12:25:56 -07:00
Kubernetes Prow Robot eea76033bc
Merge pull request #19956 from tengqm/fix-contrib-link
Fix link in contributing guide
2020-04-02 07:16:24 -07:00
Heena-PyCloud f8b863504a
This change has replaced &emdash; to &mdash; within the text (line 42). 2020-04-02 18:36:06 +05:30
Qiming Teng e5121dd0ec Fix link in contributing guide 2020-03-30 09:41:09 +08:00
Celeste Horgan fbaeb89823
Fix markdown escaping (#19744)
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-03-23 05:22:45 -07:00
Zach Corleissen 329c823aa6
KEP 1327: Apply feedback for third party and dual sourced content (#19486)
* Apply feedback for third party and dual sourced content

Add feedback from sftim

clarify which slack

* Limit third-party content to OSS

See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 15:45:25 -07:00
Brian Pursley e1397c9e2d
Fixed incorrect commands for generating docs (#19693)
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
2020-03-17 13:05:27 -07:00
inductor 4297f3b29c
Update nginx to modern versions (#19198)
* update nginx versions

* update

* update examples
2020-03-17 10:48:23 -07:00
Jacky Wu 05bf8be205
Federation Cleanup (1) doc: clean some outdate redirects and its associated content. (#19572)
* doc: clean some outdate redirects and its associated content.

* doc: also cleanup tasks.yml content.
2020-03-09 17:03:37 -07:00
Sujay Pillai ead3e36150
Fix branch names in “Start Contributing” (#19493)
* Replaced shortcodes with hard-coded values 1.17

* Updated with shortcode as per PR reveiew

* Update with proper shortcode after rebase
2020-03-08 10:23:34 -07:00
divya-mohan0209 6832cac3f3
Update content in intermediate.md (#19524)
* 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
2020-03-07 12:05:34 -08:00
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