Commit Graph

405 Commits (c8575a2bcdb99d16d0e68543a6060cd1374b021d)

Author SHA1 Message Date
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
Kubernetes Prow Robot 44cd70c2d4
Merge pull request #31653 from chrismetz09/patch-5
Add figure <number> to text and caption reviewing-prs.md
2022-02-11 08:54:24 -08:00
Kubernetes Prow Robot 1e87ec875d
Merge pull request #31627 from tengqm/tune-diagram-guide
Reformat diagram guide
2022-02-11 08:48:25 -08:00
chrismetz09 f9af064052
add period after caption text 2022-02-07 15:12:00 -08:00
chrismetz09 37a47f2a94
Add period after caption text 2022-02-07 15:09:12 -08:00
chrismetz09 e40fcde548
Add figure <number> to text and caption
File change: reviewing-prs.md

Method described in [How to use captions](https://kubernetes.io/docs/contribute/style/diagram-guide/#how-to-use-captions)

Contributes to common method for referencing and labeling figures in docs.
2022-02-07 14:45:55 -08:00
chrismetz09 b66faef3f9
removed *** at end of caption text 2022-02-07 13:15:19 -08:00
chrismetz09 9581abbe2e
Add Figure <number> to text and caption
method described in [How to use captions](https://kubernetes.io/docs/contribute/style/diagram-guide/#how-to-use-captions)
2022-02-07 11:16:05 -08:00
Qiming Teng 6ea009fa04 Wrap long lines for hugo-shortcodes page 2022-02-05 14:57:39 +08:00
Qiming Teng 439ef1f84f Reformat diagram guide
This PR wraps the long lines in the diagram guide for ease of change tracking.
It also fixes some link targets to use relative paths.
2022-02-05 12:01:47 +08:00
Shivam Singhal b49701b566 Fix link to OWNERS_ALIASES 2022-01-12 12:02:18 +02:00
Jayesh Srivastava 27d400d0e6 Update localization.md 2022-01-10 22:00:54 +05:30
Tim Bannister 7f1f16746f Include screenshot showing Netlify preview 2021-12-21 11:39:10 +00:00
chrismetz09 da6826f5cc
Diagram-Guide: corrected Figure 10 caption
for Figure 10 in How to use captions section
2021-12-20 09:55:54 -08:00
Kubernetes Prow Robot 6f019208b8
Merge pull request #30299 from chrismetz09/metz-diagStyleGuide
Add Diagram Guide to Documentation Style Overview section
2021-12-17 03:40:29 -08:00
chrismetz09 f381db2d49 fixed typos 2021-12-15 15:30:28 -08:00
Jim Angel a331d7b840 Updating SIG Co-chair requirements
Removing archaic requirements for SIG Docs co-chairs. For the record, that I did not fully meet when becoming a co-chair a couple years ago. The current set of requirements hurt more than they help.
2021-12-15 16:11:49 -06:00
chrismetz09 e830abc8bd refactored caption section and hyperlinked diagrams to live editor 2021-12-15 12:09:20 -08:00
Kensei Nakada dc5820977b
Change the role restriction for `/lgtm` 2021-12-13 23:45:26 +09:00
chrismetz09 36bcc388cf fixed colon typos 2021-12-09 12:11:25 -08:00
chrismetz09 5e17ad0f18 Add diagram guide 2021-12-09 11:44:05 -08:00
Kubernetes Prow Robot b8142bc158
Merge pull request #30792 from Deepakktripathy/mysoln
removed the italics
2021-12-09 02:32:09 -08:00
Deepak Tripathy c214d37d86 removed the italics 2021-12-07 19:00:47 +03:00
Kubernetes Prow Robot b640a95056
Merge pull request #30371 from reylejano/update-about-blogs
Add line about contributor blogs should go to kubernetes.dev on the blog-case-studies page
2021-12-05 20:06:32 -08:00
Meha Bhalodiya 798aae5127
Fix a few grammar issues and typos (#28387)
* Fix a few grammar issues and typos

* Minor changes
2021-12-05 19:50:32 -08:00
Tim Bannister 2087546633 Link to https://k8s.dev/ docs about good first issues
Where we mention the "help" or "good first issue" labels, let's
hyperlink to https://kubernetes.dev/docs/guide/help-wanted/ (our
official page on that topic).
2021-12-04 10:13:50 +00:00
Kubernetes Prow Robot 81389449f1
Merge pull request #29845 from RinkiyaKeDad/pr_wrangller_fix
adding info about tagging SIGs in pr wrangling guide
2021-12-01 06:07:16 -08:00
budhirajamadhav fbeab275d0 Fix obsolete link to sig docs agenda doc 2021-11-23 03:12:10 +05:30
RinkiyaKeDad b2d8188cc7 add hyperlink to list of sigs
Signed-off-by: RinkiyaKeDad <arshsharma461@gmail.com>
2021-11-16 15:56:43 +05:30
Kubernetes Prow Robot c3439b3e15
Merge pull request #30295 from siddhantprateek/main-v2
Mentioned Markdown flavor in Contribution new content
2021-11-12 09:38:28 -08:00
Siddhant Prateek Mahanayak 12854d0586
Suggested Changes
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-12 23:01:48 +05:30
Kubernetes Prow Robot d886d65675
Merge pull request #29957 from sftim/20211007_document_thirdparty-content_shortcode
Document {{% thirdparty-content %}} shortcode
2021-11-08 18:23:39 -08:00
Rey Lejano ba4390cf48 add line about contributor blogs to kubernetes.dev 2021-11-05 12:05:15 -07:00
Chris Short ee6b1a831e
Adding links to kubernetes.dev
Boosting the contributor site up in Google rankings is a priority for the Kubernetes Upstream Marketing team: https://github.com/kubernetes/contributor-site/issues/202

Adding links here where appropriate:
- Contributor Cheatsheet
- kubernetes.dev itself
- contributor resources
2021-11-05 12:52:38 -04:00
Siddhant Prateek 6ba1534f10
Mentioned Markdown flavor in Contribution new content
Signed-off-by: Siddhant Prateek <siddhantprateek@gmail.com>
2021-10-28 22:31:00 +05:30
Tim Bannister f5bb0c7e8a Document thirdparty-content shortcode 2021-10-27 11:04:28 +01:00
robotjellyzone 2fbb744783 added one space at end 2021-10-20 17:48:49 +05:30
robotjellyzone 5f2dd40003 added two spaces at end 2021-10-20 14:16:37 +05:30
robotjellyzone 5ad520a6ab Fixing Skew localization doc 2021-10-20 11:46:52 +05:30
chrismetz09 aec7dd4ea3 Add mermaid figures to /docs/contribute section 2021-10-12 11:30:39 -07:00
mehabhalodiya fb2cc8ed6d Delete overview.md 2021-10-05 17:56:08 +05:30
mehabhalodiya 0d58976695 Migrate Contributing new content overview into section index 2021-10-05 17:43:17 +05:30
RinkiyaKeDad 1e967d0b25 adding info about tagging SIGs in pr wrangling guide
Signed-off-by: RinkiyaKeDad <arshsharma461@gmail.com>
2021-09-28 15:53:10 +05:30
Philippe Martin 7d0e235a99 Add shortcode doc 2021-09-14 15:51:58 +02:00
Jim Angel d5b67cf560 adding zoom info for localization teams 2021-08-22 21:04:45 +00:00
Tim Bannister 191c2bf4ee Pick example versions based on current release 2021-08-04 23:12:25 +01:00
Tim Bannister 142177068b Refer to the “default” rather than “master” branch
Get ready for a switch to "main"
2021-08-04 23:12:25 +01:00