Commit Graph

487 Commits (03ae214e8129b009b7a336dfa328e3eb2cb15dc2)

Author SHA1 Message Date
Tim Bannister 98c5caf14c Revise guidance about documenting feature gate changes 2023-12-28 14:54:06 +00:00
Tim Bannister 77857bc8f9 Emphasize contributions other than docs
There are lots of ways to get involved. Make it easier to discover what
those are.
2023-12-28 14:46:33 +00:00
Takashiidobe d536e46dbd fix typos 2023-12-24 21:00:53 -05:00
Dipesh Rawat 86c6b62c13
Document how to use new metadata in feature gate description file 2023-12-23 19:13:08 +00:00
Gauravpadam e5dc3ef442 Added documentation for metrics generation
Some more fixes
2023-12-22 12:41:57 +05:30
Tim Bannister da19462259 Document feature-gate-description shortcode 2023-12-13 17:38:51 +00:00
Sarthak Patel 38b4f08008 Fix broken GitHub Learning link in _index.md 2023-12-05 00:01:56 +05:30
Kundan Kumar 9a469402e1 corrected link for traslating content 2023-11-27 12:43:14 +05:30
able8 453c19edfd Fix broken link on issue-wrangler.md 2023-11-22 14:16:09 +08:00
Kubernetes Prow Robot daed9c5d9d
Merge pull request #43710 from windsonsea/localiz
Clean up localization.md
2023-11-18 11:46:23 +01:00
Kubernetes Prow Robot 7655fb19c4
Merge pull request #43598 from windsonsea/wrangler
Tweak and adjust heading levels in issue-wrangler.md
2023-11-18 11:43:54 +01:00
Maksym Vlasov 01ac54510a
[en] Mention kubernetes/websites everywhere in the same way (#40493)
* Mention kubernetes/websites everywhere in the same way

* Acidentially ignored file during replacement

* Apply suggestions from code review
2023-11-14 13:22:29 +01:00
shixiuguo fd5ac88955 Fix the links 2023-11-14 11:10:24 +08:00
windsonsea edf4deab94 Tweak and adjust heading levels in issue-wrangler.md 2023-10-29 13:21:39 +08:00
Michael f19df105cf Clean up localization.md 2023-10-28 08:18:56 +08:00
Kubernetes Prow Robot 15a539b082
Merge pull request #41473 from utkarsh-singh1/update-docs-prerequisites-ref-docs-md
Update docs prerequisites ref docs md
2023-10-24 13:57:31 +02:00
Kubernetes Prow Robot 8f54227675
Merge pull request #42273 from haripriya9647/pr
created issue-wrangler.md
2023-10-19 11:17:55 +02:00
Haripriya b3ee8663c9 Update issue-wrangler.md 2023-10-18 12:14:57 +05:30
Haripriya bc77cff2f8 commited all the changes 2023-10-18 12:09:11 +05:30
Utkarsh Singh 4ed9c343e2 Updated con docs/contribute/generate-ref-docs/prerequisites-ref-docs.md
Signed-off-by: Utkarsh Singh <96516301+utkarsh-singh1@users.noreply.github.com>
2023-10-11 11:02:47 +00:00
Qiming Teng 80e6a832b0 Amend the style guide for line wrapping
We need to let contributors know that manual wrapping is a good
practice thus part of the style guide to make the lives of others
easier.
2023-10-02 20:54:20 +08:00
steve-hardman c7ec193da6
Update link text
Co-authored-by: Dipesh Rawat <rawat.dipesh@gmail.com>
2023-09-22 01:08:50 +01:00
steve-hardman 62c6f4886c
Update link text 2023-09-22 01:02:25 +01:00
Mengjiao Liu e8b136c3b3 Use code_sample shortcode instead of code shortcode 2023-09-05 17:10:14 +08:00
Haripriya 1cf3b648f6 Update issue-wrangler.md 2023-09-01 00:51:23 +05:30
Qiming Teng 07f224714a Fix links
This PR fixes some link errors as discovered by the `linkchecker.py` tool.
2023-08-31 21:11:57 +08:00
Sandipan Panda 94aff61918
Fix contributor comms blog guidelines link in blogs-case-studies.md 2023-08-24 21:59:10 +05:30
Haripriya 68de69d5e3 added commits as per suggestions 2023-08-18 23:29:35 +05:30
Kubernetes Prow Robot eb9db45aa3
Merge pull request #41987 from sftim/20230712_revise_home_page
Revise docs home page
2023-08-15 21:22:27 -07:00
Sreeram Venkitesh 44ced6f09a Added new contributor ambassador role to contributing guide 2023-08-10 10:23:38 +05:30
Tim Bannister 9520b96a61 Revise docs home page
Reorder and replace cards to better (I hope!) serve our readers.
2023-08-09 11:49:12 +01:00
Karthik P M 29178c6a3b
Update style-guide.md 2023-08-07 22:54:38 +05:30
Karthik-PM dc9e07cb03 added .editorconfig 2023-08-05 16:39:52 +05:30
Kubernetes Prow Robot dacb005c1b
Merge pull request #42337 from sftim/20230801_fix_codenew_advice
Fix explanation of custom code shortcode
2023-08-03 21:06:21 -07:00
Kubernetes Prow Robot 4038dcc679
Merge pull request #42249 from mengjiao-liu/update-apispec-scripts
Update outdated scripts for generating the OpenAPI spec
2023-08-02 05:12:44 -07:00
Tim Bannister 27d65c1456 Fix explanation of custom code shortcode 2023-08-02 00:44:54 +01:00
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