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
1e87ec875d
Merge pull request #31627 from tengqm/tune-diagram-guide
...
Reformat diagram guide
2022-02-11 08:48:25 -08:00
f9af064052
add period after caption text
2022-02-07 15:12:00 -08:00
37a47f2a94
Add period after caption text
2022-02-07 15:09:12 -08:00
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
b66faef3f9
removed *** at end of caption text
2022-02-07 13:15:19 -08:00
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
6ea009fa04
Wrap long lines for hugo-shortcodes page
2022-02-05 14:57:39 +08:00
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
b49701b566
Fix link to OWNERS_ALIASES
2022-01-12 12:02:18 +02:00
27d400d0e6
Update localization.md
2022-01-10 22:00:54 +05:30
7f1f16746f
Include screenshot showing Netlify preview
2021-12-21 11:39:10 +00:00
da6826f5cc
Diagram-Guide: corrected Figure 10 caption
...
for Figure 10 in How to use captions section
2021-12-20 09:55:54 -08:00
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
f381db2d49
fixed typos
2021-12-15 15:30:28 -08:00
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
e830abc8bd
refactored caption section and hyperlinked diagrams to live editor
2021-12-15 12:09:20 -08:00
dc5820977b
Change the role restriction for `/lgtm`
2021-12-13 23:45:26 +09:00
36bcc388cf
fixed colon typos
2021-12-09 12:11:25 -08:00
5e17ad0f18
Add diagram guide
2021-12-09 11:44:05 -08:00
b8142bc158
Merge pull request #30792 from Deepakktripathy/mysoln
...
removed the italics
2021-12-09 02:32:09 -08:00
c214d37d86
removed the italics
2021-12-07 19:00:47 +03:00
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
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
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
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
fbeab275d0
Fix obsolete link to sig docs agenda doc
2021-11-23 03:12:10 +05:30
b2d8188cc7
add hyperlink to list of sigs
...
Signed-off-by: RinkiyaKeDad <arshsharma461@gmail.com>
2021-11-16 15:56:43 +05:30
c3439b3e15
Merge pull request #30295 from siddhantprateek/main-v2
...
Mentioned Markdown flavor in Contribution new content
2021-11-12 09:38:28 -08:00
12854d0586
Suggested Changes
...
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-12 23:01:48 +05:30
d886d65675
Merge pull request #29957 from sftim/20211007_document_thirdparty-content_shortcode
...
Document {{% thirdparty-content %}} shortcode
2021-11-08 18:23:39 -08:00
ba4390cf48
add line about contributor blogs to kubernetes.dev
2021-11-05 12:05:15 -07:00
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
6ba1534f10
Mentioned Markdown flavor in Contribution new content
...
Signed-off-by: Siddhant Prateek <siddhantprateek@gmail.com>
2021-10-28 22:31:00 +05:30
f5bb0c7e8a
Document thirdparty-content shortcode
2021-10-27 11:04:28 +01:00
2fbb744783
added one space at end
2021-10-20 17:48:49 +05:30
5f2dd40003
added two spaces at end
2021-10-20 14:16:37 +05:30
5ad520a6ab
Fixing Skew localization doc
2021-10-20 11:46:52 +05:30
aec7dd4ea3
Add mermaid figures to /docs/contribute section
2021-10-12 11:30:39 -07:00
fb2cc8ed6d
Delete overview.md
2021-10-05 17:56:08 +05:30
0d58976695
Migrate Contributing new content overview into section index
2021-10-05 17:43:17 +05:30
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
7d0e235a99
Add shortcode doc
2021-09-14 15:51:58 +02:00
d5b67cf560
adding zoom info for localization teams
2021-08-22 21:04:45 +00:00
191c2bf4ee
Pick example versions based on current release
2021-08-04 23:12:25 +01:00
142177068b
Refer to the “default” rather than “master” branch
...
Get ready for a switch to "main"
2021-08-04 23:12:25 +01:00
45698e8c40
fix typo in content/en/docs/contribute/generate-ref-docs/quickstart.md
...
Signed-off-by: yuswift <yuswift2018@gmail.com>
2021-07-26 20:48:02 +08:00
da31234d5d
Update docs for primary branch rename to "main"
2021-06-19 01:50:25 +01:00
314179dd37
doc: remove unneeded comma
2021-06-12 18:04:39 +05:30
32dbaaaaea
Merge pull request #27991 from a-mccarthy/fix-27360
...
Add page for analytics dashboard
2021-06-08 14:58:07 -07:00
dbca4e41b7
Fix page title
2021-06-02 14:05:40 -04:00
259bdd2848
Deleted reference to removed file
2021-05-23 11:28:44 +02:00
3a8af16d57
Update with nits from reviews
2021-05-17 08:39:39 -04:00
b8ab5835b9
Add page for analytics dashboard
2021-05-14 17:12:27 -04:00
faa06b802a
Fixed variable substitution typo
2021-05-13 10:46:55 +02:00
10196aa04a
Merge pull request #27408 from sftim/20210405_allow_localizations_maintain_own_strings
...
Allow localization teams to review their own strings
2021-05-10 01:12:51 -07:00
5deefdaa9d
Switch Do's and Don'ts
2021-04-26 12:01:56 +02:00
b0ad9ff416
Revise localization guide
...
- explain new localized strings
- general tidying
2021-04-25 11:10:20 +01:00
03ab264919
Append `.git` to upstream URLs
...
The upstream URLs are missing the `.git` suffix. You can see this minor omission if you run the `git remote -v` command in your local `website` repo.
2021-04-24 16:01:21 -04:00
f7a3863970
Going emeritus, remove myself from WGs and SIGs
2021-04-20 14:25:51 -07:00
34f1d61c60
Fixed errors in instructions for generating ref docs
...
Some minor mistakes I noticed:
- WEB_ROOT is actually K8S_WEBROOT (https://github.com/kubernetes-sigs/reference-docs/blob/master/Makefile#L12 )
- copysrc puts the code in gen-apidocs/build, not gen-apidocs/generators/build (https://github.com/kubernetes-sigs/reference-docs/blob/master/Makefile#L89 )
- K8S_VERSION must have a patch number, because all kubernetes tags have patch numbers (https://github.com/kubernetes/kubernetes/tree/v1.17 vs https://github.com/kubernetes/kubernetes/tree/v1.17.0 )
2021-04-02 14:20:37 -04:00
3ff5ec1eff
clean up use of word: just
2021-03-17 19:57:40 -04:00
3f373fd71a
Merge pull request #25795 from shu-mutou/update-l10n
...
Fix `Source files` in localization document.
2021-02-27 18:40:39 -08:00
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
8de202cfa1
Merge pull request #26580 from kbhawkey/update-style-extraneous-words
...
update style guide (insensitive words)
2021-02-25 13:48:15 -08:00
27013dfbf5
Describe helper scripts for localization
2021-02-20 12:13:36 +09:00
e13661c5fe
update style guide
2021-02-16 19:14:13 -05:00
ec4df0f2cf
Address review comments
2021-02-14 15:50:12 -05:00
3fd65482e8
clean up use of word: simply
2021-02-07 12:15:29 -05:00
96c4813972
revise guidance for Pascal Case
2021-02-05 21:53:37 +00:00
0166a0b08e
add docs for version shortcodes
2021-01-12 17:20:33 -05:00
64594a4c60
Correct camelcase of DaemonSet
2020-12-23 09:22:27 -05:00
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
cf76fafcff
Use k8s more widely
...
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-11-12 10:43:46 -08:00
daa2c4718d
Fix branch name advice
...
Fixup for commit 28c8c2e9b2
2020-11-11 23:35:06 +00:00
f41b214818
fix branch name
2020-11-12 01:24:31 +02:00
7c2f959048
fix branch name
2020-11-12 01:09:02 +02:00
96a86da7c1
fix branch name
2020-11-12 01:02:31 +02:00
972b2c5c40
Fix links in contribute section
2020-10-22 15:11:11 +08:00
edac0b3c2e
Modify to change repo names to hyperlinks
2020-10-14 12:15:40 -05:00
a2e9bddd90
Add a technical review requirement for feature documentation
2020-10-14 11:10:32 -05:00
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
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
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
46812e34a0
Hyperlink to https://k8s.dev/
2020-10-10 18:35:00 +01:00
2c31d6a19d
Update new feature doc to add a step to include necessary links
2020-10-09 15:11:27 -05:00
12bc18da7c
Update meeting link and details
2020-10-07 16:29:09 -04:00
4d38696fc7
added the word meeting to clarify
2020-10-07 15:39:03 -04:00
376a8d4940
Updated slack URLs and fixed typo
2020-10-07 15:36:04 -04:00
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
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
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
7ef62d255a
Fix the instruction to click the "Create an issue" link.
2020-09-16 00:18:10 +09:00
f6ffc7c881
Merge pull request #23028 from sftim/20200808_fix_glossary_definition_shortcode
...
Fix glossary definition shortcode
2020-08-26 14:57:04 -07:00
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
c6a96128c4
Replace special quote characters with normal ones.
2020-08-11 21:05:22 +09:00
1732bbd93d
Fixes broken link to website issues
2020-08-04 10:21:19 +01:00
879651c83b
Merge pull request #22606 from zacharysarah/update-l10n-contrib
...
Update the Slack channel creation example
2020-08-03 04:53:42 -07:00
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
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
Kubernetes Prow Robot
chrismetz09
Qiming Teng
Shivam Singhal
Jayesh Srivastava
Tim Bannister
Jim Angel
Kensei Nakada
Deepak Tripathy
Meha Bhalodiya
budhirajamadhav
RinkiyaKeDad
Siddhant Prateek Mahanayak
Rey Lejano
Chris Short
Siddhant Prateek
robotjellyzone
Philippe Martin
Jim Angel
yuswift
Abigail McCarthy
Martin Kanters
Peter Sutter
Rolfe Dlugy-Hegwer
zacharysarah
Nick Santos
Karen Bradshaw
Shu Muto
June Yi
Jordan Liggitt
Geoffrey Cline
Dan Roscigno
Anna Jung (VMware)
Celeste Horgan
Arhell
Qiming Teng
Anna Jung
Brad Topol
Bob Killen
Casie Oxford
TAKAHASHI Shuuji
Aashu Anshuman