Commit Graph

451 Commits

Author SHA1 Message Date
Haripriya dcee41b6e5 added prow commands and when to close issues 2023-07-30 00:54:45 +05:30
Haripriya 5cc83a8363 updated as per suggestions 2023-07-29 22:31:56 +05:30
Haripriya 67b931ea14 created issue-wrangler.md 2023-07-28 18:36:05 +05:30
Mengjiao Liu 8ff6b018f9 Update outdated scripts for generating the OpenAPI spec 2023-07-27 19:16:11 +08:00
Mengjiao Liu f5388a1efe Add code shortcode to replace codenew 2023-07-27 17:27:26 +08:00
Andrey Goran eb522c126f
Replace {{< codenew ... >}} with {{% codenew ... %}} in all English docs (#42180)
* Replaced {{< codenew ... >}} with {{% codenew ... %}} in all files

* Reverted changes in non-english localizations
2023-07-25 05:54:06 -07:00
Mohammed Boukhalfa 4737689819
Translating SVG images in localization contributions 2023-07-12 19:46:11 +03:00
AmarNathChary ae69059fb1 fixed buggy example note shortcode 2023-06-21 13:29:17 +05:30
utkarsh-singh1 948dec77a8 Updated oudated links in pre-requisites-ref-docs.md
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2023-06-05 15:41:17 +05:30
Michael 1ec7fe8e63 Tweak line wrappings in content-organization.md 2023-06-01 21:49:31 +08:00
able8 a7604dc93e correct git clone url 2023-05-08 21:34:47 +08:00
Kubernetes Prow Robot 7b262f6d32
Merge pull request #40306 from sftim/20230323_drop_katacoda
Drop or adapt tutorials that rely on Katacoda
2023-03-31 09:01:49 -07:00
Tim Bannister 252bcf6c29 Adapt Kubernetes basics tutorials for local use
Avoid relying on Katacoda.

Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-03-28 15:23:31 +01:00
Michael 0bc196344b Tweak lines and fix indentations in for-approvers.md 2023-03-27 22:14:25 +08:00
Rolfe Dlugy-Hegwer cb1a807fa5 Add guidance for reviewers about squashing commits 2023-03-27 07:33:26 -04:00
Arhell 73bfd0ec56 [en] update hugo config file 2023-03-19 00:56:47 +02:00
Dipesh Rawat e7e4de3a0f
Added info for <codenew> shortcode in style guide (#39764)
* Add info for codenew shortcode in style guide

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>

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

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

* Addressed feedback comments

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>

* Update content/en/docs/contribute/style/hugo-shortcodes/index.md

Co-authored-by: Brad Topol <btopol@us.ibm.com>

* Update content/en/docs/contribute/style/hugo-shortcodes/index.md

Co-authored-by: Brad Topol <btopol@us.ibm.com>

---------

Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Brad Topol <btopol@us.ibm.com>
2023-03-08 05:37:12 -08:00
Mauren Berti e16623fb96
fix: remove excessive line breaks in headings and titles section.
The subsection Headings and Titles of this document contains a dos and don'ts table that was
not rendering correctly do to a few surplus line breaks inside the Markdown for the table.
This commit removes these spaces so the table renders correctly.
2023-02-26 17:06:50 -05:00
Kubernetes Prow Robot 0f12ff8ea6
Merge pull request #38453 from stormqueen1990/update-locale-docs
[en] Document when country codes are used in the Kubernetes documentation
2023-02-22 11:54:29 -08:00
Mauren Berti 37866ea7c9
Changes from review. 2023-01-21 17:26:32 -05:00
Jim Angel 5b44de3dd1 Jim Angel going to emeritus 2023-01-09 23:42:56 -06:00
Subhasish Panda b6499ef3f7
Improved the steps for opening a PR using GitHub 2022-12-26 23:48:45 +05:30
Mauren Berti 07097ddc28
[en] Add information on when to use country codes. 2022-12-13 08:07:15 -05:00
windsonsea d7ceef3bae Fix a link in new-features.md 2022-11-10 09:15:15 +08:00
Kubernetes Prow Robot c711f747de
Merge pull request #37557 from sftim/20221027_retitle_reference_docs_generation
Revise section title for “Reference Docs Overview”
2022-11-08 23:24:13 -08:00
Kubernetes Prow Robot 9f3aead0b6
Merge pull request #35621 from Sea-n/contributer-role
Reword in sig-docs contributor roles
2022-11-08 15:06:14 -08:00
Kubernetes Prow Robot 7728ad9424
Merge pull request #37510 from windsonsea/locen
Fix bullet alignment errors in localization.md
2022-11-03 10:27:37 -07:00
kadtendulkar c098f10604 Update content/en/docs/contribute/style/write-new-topic.md 2022-10-30 20:07:29 +05:30
Tim Bannister 3c33ffc914 Tweak reference docs section index
No need to mention the quickstart twice.
2022-10-27 15:04:30 +01:00
Tim Bannister e071c5f206 Revise page title 2022-10-27 12:34:25 +01:00
Michael 4980846fa1 Fix errors in localization.md 2022-10-25 21:02:28 +08:00
Kubernetes Prow Robot 9892bebe04
Merge pull request #36878 from rolfedh/exp-lang-sty-gui
Expand the "Language specific style guide and glossary" section
2022-10-24 11:54:24 -07:00
Seokho Son 35ebbd1e41 Update page weights for pages in content/en/docs/contribute 2022-10-25 01:09:47 +09:00
Kubernetes Prow Robot 8eb5e4650c
Merge pull request #35990 from shannonxtreme/patch-3
Add title case style guideline
2022-10-22 01:53:56 -07:00
kadtendulkar 75ef3b4a42 Update content/en/docs/contribute/new-content/blogs-case-studies.md
Update content/en/docs/contribute/new-content/blogs-case-studies.md

Update content/en/docs/contribute/new-content/blogs-case-studies.md
2022-10-19 13:31:06 +05:30
Rey Lejano 20ecf6482c update new-features page for new ga or removed features page 2022-10-04 12:12:35 -07:00
Tim Bannister 336cd5f23e
Revise PR review guidelines
- Mention trivial edits
- It's OK if an author leaves in an existing grammar or spelling error
  that is not related to the issue they are fixing / the change they are
  making.

Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>
Co-authored-by: Abigail McCarthy <mabigail@vmware.com>
2022-09-29 15:34:57 +01:00
Sean Wei 35621ef457 Reword in sig-docs contributor roles 2022-09-28 12:20:33 +08:00
Shannon Kularathna e688bb87bb Add title case style guideline 2022-09-21 20:54:48 +00:00
Kubernetes Prow Robot 790beba33e
Merge pull request #36892 from bconfiden2/0919-pageorder
Add note about page weights and localization
2022-09-20 11:49:15 -07:00
bconfiden2 73def14e96 Revise content-organization.md 2022-09-20 13:27:12 +09:00
Sean Wei 36899cd93c Update some contributor page 2022-09-20 09:16:42 +08:00
Rolfe Dlugy-Hegwer 271ca8504b Updated localization. Edited for style. 2022-09-17 19:42:36 -04:00
cathchu e5ea8833be Merge remote-tracking branch 'upstream/main' into dev-1.25 2022-08-22 08:35:18 -04:00
Kubernetes Prow Robot 8da91667f9
Merge pull request #35587 from Sea-n/rename-sig-docs-reviews
Change sig-docs-xx-reviewers to -reviews in docs
2022-08-18 13:00:11 -07:00
carolina valencia 6810fa976d Merge remote-tracking branch 'upstream/main' into dev-1.25 2022-08-18 15:58:41 -03:00
Jordan Liggitt b167938367 Scrub PSP docs for 1.25 2022-08-15 21:09:41 -04:00
ydFu 8183d5a62d Fix the extra '{' or '}'
Signed-off-by: ydFu <ader.ydfu@gmail.com>
2022-08-14 15:36:13 +08:00
Vaibhav a0cc8c7913 Updated the blog guidelines link 2022-08-10 13:05:33 +05:30
Sean Wei 35587abca4 Change sig-docs-xx-reviewers to -reviews in docs 2022-08-01 02:39:31 +08:00
Kubernetes Prow Robot c932262b65
Merge pull request #35119 from Rishit-dagli/Rishit-dagli-api-resources-style
Add clarification about API resources to the Style Guide
2022-07-25 00:18:58 -07:00
Kubernetes Prow Robot 7078c38d3b
Merge pull request #33792 from sftim/20220510_assign_pod_node_affinity_updates
Revise scheduling-related docs
2022-07-24 03:38:57 -07:00
Rishit Dagli 989e8ac98c Add clarification about API resources to the Style Guide 2022-07-23 18:37:34 +00:00
Kubernetes Prow Robot d2de85c52a
Merge pull request #34411 from tengqm/update-review-guide
Improve reviewing PRs guide
2022-07-19 10:56:07 -07:00
Guangwen Feng 525a952b95 Fix indentation and clean up in open-a-pr.md
Signed-off-by: Guangwen Feng <fenggw-fnst@fujitsu.com>
2022-07-18 14:23:48 +08:00
Guangwen Feng 438d534b9d Fix incorrect format in open-a-pr.md
Signed-off-by: Guangwen Feng <fenggw-fnst@fujitsu.com>
2022-07-16 15:56:36 +08:00
Guangwen Feng 6635f978a6 Fix a number error in open-a-pr.md
Signed-off-by: Guangwen Feng <fenggw-fnst@fujitsu.com>
2022-07-15 16:54:54 +08:00
Tim Bannister ed58f048b9 Fix typo 2022-07-14 23:59:07 +01:00
Tim Bannister 6700656cb4 Move Pod Topology Spread Constraints into scheduling
These constraints apply specifically to the mechanism for placing Pods
onto nodes (that is, scheduling).
2022-07-14 23:59:05 +01:00
utkarsh-singh1 70ace47f66 Updated the style-guide doc
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2022-07-13 21:55:32 +05:30
Bishal Das 9e70d30559
Replaced all k/website in localization guide with kubernetes/website only 2022-07-06 17:45:10 +05:30
Kubernetes Prow Robot e6868ba8d3
Merge pull request #34721 from Sea-n/use-rel-links
Use relative links for k8s.io
2022-07-04 06:33:24 -07:00
Kubernetes Prow Robot 6b67b2a1c6
Merge pull request #34376 from tengqm/tweak-open-pr
Reformat the open a PR page
2022-07-02 01:17:23 -07:00
Sean Wei 34721abcac Use relative links for k8s.io 2022-06-30 12:08:14 +08:00
chrismetz09 5fb97e57a4
mermaid shortcode mentioned in Note causes error
Couple of Notes in the [Diagram Guide](https://kubernetes.io/docs/contribute/style/diagram-guide/) include mention of the Hugo Mermaid shortcode. This generates a syntax error. Appears that Hugo interprets this as a Mermaid diagram.

```
{{< note >}}
You must include the `{{</*  mermaid */>}}`, `{{</* /mermaid */>}}` shortcode
tags at the start and end of the Mermaid code block. You should add a diagram
caption below the diagram. 
{{< /note >}}

```

This PR removes the `{{< mermaid >}}` mention inside the `{{< note >}} so that Hugo does not attempt to render a diagram.
2022-06-28 11:19:41 -07:00
Bishal Das a26d226d7c
removed extra "the" in the line 2022-06-28 10:09:25 +05:30
Qiming Teng 7c1daf3c5e Improve reviewing PRs guide
This PR proposes an update to the PR review guidelines. The proposed change is about the use of the "Request changes" or the "Approve" option when finishing a PR review. Neither of these two options should be encouraged. We may want to encourage reviewers to always use "Comment", because:

- "Request changes" status is sticky and unnecessary. Placing a "/hold" should be okay because we do respect opinions from all reviewers/approvers.
  The "Request changes" status can only be discarded by people with privileges.
  We see quite a few cases where the reviewer left a "Request changes" mark and forgot to revisit a PR.
  Such a sticky status is not friendly to contributors or peer reviewers.

- The "Approve" option is confusing. It is not considered by the prow as an approval IIUC. The PR has to be approved again even if it has been "approved" this way.
2022-06-25 10:08:43 +08:00
Kubernetes Prow Robot 78249f3ec9
Merge pull request #34378 from tengqm/fix-links-2
Fix links in some pages (2)
2022-06-24 00:37:20 -07:00
Kubernetes Prow Robot cb136e8804
Merge pull request #34374 from tengqm/tweak-localization
Tweak localization page
2022-06-23 16:33:20 -07:00
kadtendulkar 8edb644960 Update content/en/docs/contribute/localization.md 2022-06-23 21:59:43 +05:30
Qiming Teng 9b5e2aec1b Fix links in some pages
This PR fixes some links that are using redirect records or dangling.
2022-06-21 11:15:15 +08:00
Qiming Teng a35c434664
Merge branch 'main' into tweak-localization 2022-06-21 10:44:14 +08:00
Kubernetes Prow Robot 88210db4b6
Merge pull request #34377 from tengqm/tweak-blogs-casestudy
Reformat blog case studies page
2022-06-20 04:04:04 -07:00
Kubernetes Prow Robot e4282f722a
Merge pull request #34310 from Sea-n/sync-coc
Sync code of conduct from cncf upstream
2022-06-20 03:28:06 -07:00
Qiming Teng 700433da48 Tweak localization page 2022-06-18 15:46:45 +08:00
Qiming Teng aa585d2c29 Reformat the open a PR page 2022-06-18 15:29:20 +08:00
Qiming Teng fc4db89d6e Reformat blog case studies page 2022-06-18 15:23:19 +08:00
Kubernetes Prow Robot 65597a1618
Merge pull request #34112 from sftim/20220602_skip_container_image_build
Avoid recommending a local container image build
2022-06-16 22:06:31 -07:00
Kubernetes Prow Robot 014979f34a
Merge pull request #32933 from a-mccarthy/fixes-31657
Update config.toml for language name standardization
2022-06-16 22:02:32 -07:00
Kubernetes Prow Robot 83a5624a16
Merge pull request #31652 from chrismetz09/patch-4
Add Figure <number> to text and caption open-a-pr.md
2022-06-15 20:26:48 -07:00
Sean Wei 34311def9f Sync code of conduct from cncf upstream 2022-06-16 02:00:03 +08:00
Seth McCombs ab3910b337 rename fejta bot to k8s-triage-robot 2022-06-13 09:22:22 -07:00
Abigail McCarthy 3272b3577c
Merge branch 'main' into fixes-31657 2022-06-06 08:06:13 -04:00
Tim Bannister c7730937a4
Skip building a container image for local previews
Most of the time, you can pull the image from the internet.
2022-06-02 14:20:48 +01:00
Sean Wei cca0aca855 Fix Markdown link 2022-05-25 21:17:01 +08:00
Tim Bannister aa8e2b3991
Link to CNCF k8s contribution guide 2022-05-23 13:42:30 +01:00
Emin ALEMDAR 234baa1f3f
Related to #33705
I have removed the second add from the page.
2022-05-16 15:57:54 +03:00
Sean Wei 649328ac2f Use JavaScript instead of Javascript 2022-04-24 11:54:22 +08:00
Abigail McCarthy 2d55351263 Update config.toml for language name standardization
Update langiagenamelatinscript varibale

Fix languageNameLatinScript

update localization standards examples
2022-04-15 09:55:02 -04:00
Kubernetes Prow Robot b69b3d76cb
Merge pull request #32098 from Babapool/pr-shadow-wrangler-docs
Add documentation for PR Wrangler Shadow program
2022-04-12 10:33:24 -07:00
Vitthal Sai 4a05cab07e
Adds documentation for PR Wrangler Shadow program 2022-04-06 00:10:50 +05:30
Noah Ispas (iamNoah1) c231ba5be3 add necessary tools, correct git output example 2022-04-05 10:15:15 +02:00
Seokho Son 3f70b2fca7 Update description for languageName 2022-04-05 00:47:45 +09:00
Seokho Son 258b71ae01 Update l10n guide to use both native and English names 2022-04-04 23:25:00 +09:00
Kubernetes Prow Robot 0754ec0546
Merge pull request #31654 from chrismetz09/patch-6
Add figure <number> to text/caption _index.md
2022-03-07 14:38:24 -08:00
chrismetz09 73ac0a7c0d Add figure <number> to text/caption in docs/contribute/ _index.md 2022-03-07 09:47:47 -08:00
Chris Negus 8ca3492e51
Moved blog guidance from SIG page to docs (#31920)
* Moved blog guidance from SIG page to docs

* Fixed text from review comments
2022-03-02 18:48:48 -08:00
Jordan Liggitt b19e4ff868 Allow marking some blog posts as evergreen and exempt from outdated warning 2022-02-27 17:25:36 -05:00
Arsh Sharma 3c38080005
Update content/en/docs/contribute/advanced.md
Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>
2022-02-18 13:07:03 +05:30
Arsh Sharma ca51b25078 mention about monthly meeting in NCA responsibilities
Signed-off-by: Arsh Sharma <arshsharma461@gmail.com>
2022-02-16 18:26:23 +05:30