Commit Graph

290 Commits

Author SHA1 Message Date
Karen Bradshaw 3ff5ec1eff clean up use of word: just 2021-03-17 19:57:40 -04:00
Kubernetes Prow Robot 3f373fd71a
Merge pull request #25795 from shu-mutou/update-l10n
Fix `Source files` in localization document.
2021-02-27 18:40:39 -08:00
Shu Muto de1b4d7635 Fix `Source files` in localization document.
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>
2021-02-26 13:56:24 +09:00
Kubernetes Prow Robot 8de202cfa1
Merge pull request #26580 from kbhawkey/update-style-extraneous-words
update style guide (insensitive words)
2021-02-25 13:48:15 -08:00
June Yi 27013dfbf5 Describe helper scripts for localization 2021-02-20 12:13:36 +09:00
Karen Bradshaw e13661c5fe update style guide 2021-02-16 19:14:13 -05:00
Jordan Liggitt ec4df0f2cf Address review comments 2021-02-14 15:50:12 -05:00
Karen Bradshaw 3fd65482e8 clean up use of word: simply 2021-02-07 12:15:29 -05:00
Geoffrey Cline 96c4813972 revise guidance for Pascal Case 2021-02-05 21:53:37 +00:00
Karen Bradshaw 0166a0b08e add docs for version shortcodes 2021-01-12 17:20:33 -05:00
Dan Roscigno 64594a4c60
Correct camelcase of DaemonSet 2020-12-23 09:22:27 -05:00
Anna Jung (VMware) 1890273af0 Update documenting a feature for a release doc
Signed-off-by: Anna Jung (VMware) <antheaj@vmware.com>
2020-11-30 19:17:37 -06:00
Celeste Horgan cf76fafcff Use k8s more widely
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 10:43:46 -08:00
Tim Bannister daa2c4718d Fix branch name advice
Fixup for commit 28c8c2e9b2
2020-11-11 23:35:06 +00:00
Arhell f41b214818 fix branch name 2020-11-12 01:24:31 +02:00
Arhell 7c2f959048 fix branch name 2020-11-12 01:09:02 +02:00
Arhell 96a86da7c1 fix branch name 2020-11-12 01:02:31 +02:00
Qiming Teng 972b2c5c40 Fix links in contribute section 2020-10-22 15:11:11 +08:00
Anna Jung edac0b3c2e Modify to change repo names to hyperlinks 2020-10-14 12:15:40 -05:00
Anna Jung a2e9bddd90 Add a technical review requirement for feature documentation 2020-10-14 11:10:32 -05:00
Kubernetes Prow Robot 65540d14b2
Merge pull request #24450 from annajung/master
Update PR template to include a requirment for release related docs
2020-10-12 17:15:22 -07:00
Kubernetes Prow Robot b584dbf740
Merge pull request #24476 from sftim/20201010_link_to_contributor_site
Hyperlink from https://k8s.io/docs/contribute/ to https://k8s.dev/
2020-10-12 17:03:22 -07:00
Tim Bannister e11d3ea5f6 Use make-container serve by default
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.
2020-10-12 09:19:07 +01:00
Tim Bannister 46812e34a0 Hyperlink to https://k8s.dev/ 2020-10-10 18:35:00 +01:00
Anna Jung 2c31d6a19d Update new feature doc to add a step to include necessary links 2020-10-09 15:11:27 -05:00
Brad Topol 12bc18da7c Update meeting link and details 2020-10-07 16:29:09 -04:00
Brad Topol 4d38696fc7 added the word meeting to clarify 2020-10-07 15:39:03 -04:00
Brad Topol 376a8d4940 Updated slack URLs and fixed typo 2020-10-07 15:36:04 -04:00
Brad Topol afcd5b2fb0 Updated localization contribute page with information about
the new localization subgroup and its slack channel

Signed-off-by: Brad Topol <btopol@us.ibm.com>
2020-10-07 12:52:40 -04:00
Bob Killen ca77c1cb14
Update triage/support label in for-approvers doc
Migrates triage/support -> kind/support.

The for-aprovers.md doc was missed in the update applied in
5878a2a73d
2020-10-02 08:40:41 -04:00
Casie Oxford 826d53c81f
Update style guidelines for API object capitalization & formatting (#23497)
* Update style-guide.md

updates to api object handling according to SIG email discussion.

* Update content/en/docs/contribute/style/style-guide.md

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

* Update style-guide.md

updating API Object Examples

* Update content/en/docs/contribute/style/style-guide.md

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

* Update content/en/docs/contribute/style/style-guide.md

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

* Update content/en/docs/contribute/style/style-guide.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-09-27 13:10:48 -07:00
TAKAHASHI Shuuji 7ef62d255a Fix the instruction to click the "Create an issue" link. 2020-09-16 00:18:10 +09:00
Kubernetes Prow Robot f6ffc7c881
Merge pull request #23028 from sftim/20200808_fix_glossary_definition_shortcode
Fix glossary definition shortcode
2020-08-26 14:57:04 -07:00
Tim Bannister c105f1a03a Fix glossary definition shortcode
Fix a bug rendering short glossary definitions. Also, add an example
of a short glossary definition to the style guide.
2020-08-11 22:41:42 +01:00
TAKAHASHI Shuuji c6a96128c4
Replace special quote characters with normal ones. 2020-08-11 21:05:22 +09:00
Aashu Anshuman 1732bbd93d
Fixes broken link to website issues 2020-08-04 10:21:19 +01:00
Kubernetes Prow Robot 879651c83b
Merge pull request #22606 from zacharysarah/update-l10n-contrib
Update the Slack channel creation example
2020-08-03 04:53:42 -07:00
Kubernetes Prow Robot 20a1a5cbf0
Merge pull request #22902 from kubernetes/jimangel-prow-commands-1
adding helpful prow commands for PR wranglers
2020-08-03 04:51:40 -07:00
Jim Angel 259a2e147d
adding helpful prow commands for PR wranglers
I found myself adding the following labels on a few PRs.
2020-08-01 18:00:44 -05:00
Qiming Teng efe536f45a [zh] Fix links in contribute section
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
2020-07-27 17:58:20 +08:00
Jim Angel eb80d248ab fixing hold label filter for PR wranglers 2020-07-26 20:27:51 -05:00
Qiming Teng 96b76320c7 Remove the 'slug' attribute from open-a-pr
The slug is causing problems for tracking missing links. Other than
that, I'm not seeing any advantage of using it.
2020-07-21 18:55:59 +08:00
Kubernetes Prow Robot 1a7e81f77e
Merge pull request #22550 from tengqm/fix-links-contrib
Tidy up: fix bad links in contribution guide
2020-07-20 18:21:13 -07:00
zacharysarah 989f223fd5 Update the Slack channel creation example 2020-07-20 17:58:49 -07:00
Qiming Teng 139da7d731 Tidy up: fix bad links in contribution guide 2020-07-20 09:53:11 +08:00
Lauri Apple 5700f1012d
removed a reference to sig-pm
I deleted a reference to sig-pm, which no longer exists (since April 2020).
2020-07-16 10:03:07 +02:00
Jorge O. Castro 8045c19d6f
Revise blog submission guidelines as per the blog subproject (#22176)
* Draft of new blog submission guidelines as per the blog subproject

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>

* Add explicit requirement of original content, link to the license, and
review clarifications

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Remove whatsnext heading

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Add a warning about filename conventions not using periods

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Update content/en/docs/contribute/new-content/blogs-case-studies.md

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>

Co-authored-by: Taylor Dolezal <onlydole@users.noreply.github.com>
Co-authored-by: Celeste Horgan <celeste@cncf.io>
2020-07-15 10:38:38 -07:00
Kubernetes Prow Robot 3302b8013a
Merge pull request #22401 from SataQiu/update-20200707
Mark `make docker-serve` as deprecated in the docs
2020-07-09 16:50:34 -07:00
Kubernetes Prow Robot c63154c176
Merge pull request #22284 from celestehorgan/pr-wranglers
Add page for PR wranglers
2020-07-09 11:20:34 -07:00
SataQiu 66599808bf fix wrong note shortcode 2020-07-09 14:54:56 +08:00
SataQiu f8de42868f mark docker-serve as deprecated in the docs 2020-07-09 14:36:02 +08:00
Celeste Horgan b05f9569c7 Address feedback 2020-07-06 15:56:46 -07:00
Celeste Horgan a6a41daee9
Apply suggestions from code review
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-07-06 11:54:22 -07:00
Kubernetes Prow Robot 8056a69b38
Merge pull request #22301 from kbhawkey/kb-example-content-move
create archetype files, _index cleanup
2020-07-06 03:42:50 -07:00
Jerry Park 64f62106c1 Fix issue of document link in some documents 2020-07-05 22:46:08 +09:00
Kubernetes Prow Robot c452e65a62
Merge pull request #22225 from kbhawkey/kb-update-readme-submodule
add info about updating docsy theme
2020-07-03 20:24:48 -07:00
Karen Bradshaw 0249f62e65 add docs about archetype pages 2020-07-03 11:03:05 -04:00
Karen Bradshaw 1950c95b87 cleanup setup, contribute, tutorials index pages 2020-07-03 11:03:05 -04:00
joelbyronbarker 072d04c912 Update open-a-pr.md
Last link to /contribute/review/reviewing-prs was misstyped. Change resolves 404 when clicking it.
2020-07-02 21:24:24 -07:00
Celeste Horgan 25e76c0273 Add page for PR wranglers 2020-07-02 15:50:59 -07:00
Karen Bradshaw 1739ac97c1 update open-new-pr, docsy info 2020-07-01 10:42:44 -04:00
Celeste Horgan 7e3940f9ee Make roles and responsibilities its own page
Signed-off-by: Celeste Horgan <celeste@cncf.io>

Update content/en/docs/contribute/participate/_index.md

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
2020-06-30 13:33:02 -07:00
Maciej Szulik 00f502fa6a
Update kubectl run from docs where necessary
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.
2020-06-25 13:37:14 +02:00
Kubernetes Prow Robot 5e832689dc
Merge pull request #21915 from bradtopol/wrangleupdate
update wrangler doc to relax style guidelines for content
2020-06-21 07:56:39 -07:00
Brad Topol 1752d9ee2d updated phrasing 2020-06-20 00:39:12 -04:00
Brad Topol 60f0422f3a updated wrangler doc to denote agreed to relaxing of
style guidelines for good technical content as
agreed at last planning meeting

Signed-off-by: Brad Topol <btopol@us.ibm.com>
2020-06-19 10:42:43 -04:00
makocchi-git 1862f2d961
update what's next contents 2020-06-18 13:10:10 +09:00
makocchi-git 2819a92dc0
update what's next contents 2020-06-18 13:04:31 +09:00
Roy Lenferink bdc173ce13 Update docs for new container- Makefile targets 2020-06-15 12:28:23 +02:00
Karen Bradshaw 2451517bf1 add more content about headings 2020-06-12 08:30:04 -04:00
Karen Bradshaw 0bf1b10411 fix link, edit content 2020-06-10 16:06:05 -04:00
Karen Bradshaw 5fe8c3ca5e move setup konnectivity svc
move api-access to extend-kubernetes
2020-06-10 16:06:01 -04:00
Karen Bradshaw 38250940c3 create page-content-types 2020-06-09 19:33:15 -04:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Karen Bradshaw 311679eeb4 clean up prior api refs and links 2020-05-29 12:09:44 -04:00
zacharysarah 549ae4d7e9 Clarify permitted content 2020-05-28 14:01:43 -07:00
Tim Bannister 2eb6ab1ad3 Add a link checker
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-05-26 16:06:46 -07:00
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