Commit Graph

378 Commits

Author SHA1 Message Date
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