Commit Graph

32 Commits (3d63002fa36d970c5a8708dcee000fd6e623517e)

Author SHA1 Message Date
Jim Angel a48b34474a
updating agenda meeting link (#19087) 2020-02-12 03:28:52 -08:00
Tim Bannister d0f6d60ec9
Revise pull request template (#18744)
* Revise pull request template

* Reference compiled docs in PR template

Refer readers to https://k8s.io/contribute/start/

This keeps the template short, and it lets Hugo use templating for
the current version.
2020-02-03 23:25:26 -08:00
aimeeu cf390493af Add best practices to Review docs pull requests (#16770)
Simply and reduce language in bullet points

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-14 16:13:50 -07:00
Karen Bradshaw 04476d0c3d fix spelling in contribute/start (#16767) 2019-10-11 14:54:04 -07:00
PingWang d99bfecfa9 Correct the #sig-docs URL (#16763)
Signed-off-by: PingWang <wang.ping5@zte.com.cn>
2019-10-09 06:09:51 -07:00
aimeeu d80ab90cdb Add references to Content guide alongside Style guide (#16101)
Add references to the Content guide where the Style guide was
mentioned.
Update the Contribute page (_index.md)
Make Style and Content linkable everywhere
Changed bullet list to numbered list in Content Guide to make referring
to sections easier.
Reverted change to bullet list - beyond scope of this PR

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-09-25 08:52:01 -07:00
Kaitlyn Barnard 9962db5ac3 Swap out link for Kubernetes blog submission form (#16089) 2019-09-04 20:16:51 -07:00
aimeeu c9d9e1be14 Add Content Guide to clarify allowed content (#15892)
Add new section for content guidelines
Add table of examples of what is and is not allowed
Add examples of links to Linux Academy courses based on discussion
during the Aug 20 SIG Docs meeting.
Remove example table and reformat based on feedback
Move content guide to its own page
Update existing pages to mention new Content Guide page

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-26 17:56:39 -07:00
sNathan13 8c4a2bf73c Adding PR review request etiquette (#15972) 2019-08-20 19:27:17 -07:00
Max Kaminskiy 7fc8050389 Note to limit changes in PR to one language (#15773)
* Updated Start Contributing docs asking to limit changes to one
language in each PR.

* Moved note about one language per PR to end of step 5.
2019-08-15 20:30:33 -07:00
aimeeu 8eba965dff Update Participating in SIG Docs and Submit a PR (#15697)
Add hyperlink to 'communicate' in Participating in SIG Docs section.
Hyperlink points to Participating in SIG Docs discussions section further down the page.

Add info to Submit a pull request bullet 5 about putting fixes #<issue_number>
or closes #<issue_number> to the PR description so GitHub will automatically close the issue
2019-08-07 14:46:37 -07:00
aimeeu efa8bf1c37 Update link to Docs SIG agenda document (#15703)
The basics about our docs/Style guidelines:  "add it to the agenda" updated the link to point to 2019 agenda document
2019-08-06 11:43:56 -07:00
Tim Bannister 3ca1955a13 Add “CNCF” to glossary (#14537)
* Add glossary entry for CNCF

* Use CNCF glossary entry
2019-07-11 18:03:07 -07:00
Danny Berger 4029a7ab5e Normalize case: Github -> GitHub (#13828) 2019-04-25 09:40:47 -07:00
zhangqx2010 28dacc8c09 update start.md on `Submit a pull request` topic (#13633)
related issue #13629
2019-04-08 22:39:04 -07:00
zhangqx2010 ff061697cf Update start.md (#13610)
Change the pencil icon location from `top left` to `top right`
2019-04-04 10:29:53 -07:00
Karen Bradshaw 71662ad94b fix typo in start contributing (#12906) 2019-02-28 20:31:51 -08:00
Dani Comnea 943429988d Add the meeting calendar to the contrib docs (#12855) 2019-02-27 03:17:13 -08:00
June Yi 8e5d7e4829 Make k8s.io/docs/home to support i18n (#12570)
* Make k8s.io/docs/home to support i18n

* Apply kbhawkey's review comment
2019-02-21 08:24:20 -08:00
Bill Mulligan bb28f4f07b fix broken link (#12346)
#fix-it doesn't lead anywhere so I changed it to link to improving content
2019-01-23 08:53:25 -08:00
Zach Corleissen d1df4b6437 Add guidelines for working with localized content (#11415)
Clarify about where to look for specific l10n tasks

More accurate link pointer

Update link for upstream contributions
2018-11-29 19:36:59 -08:00
Luc Perkins d65e1790ff Add admonition type to shortcode (#9482)
* Change existing admon blocks

* Fix includes issue
2018-11-06 11:33:04 -08:00
Robin Rakowski 2123433ed7 update to start.md fixing broken links (#10787)
Changed the two previously-broken links in the "Sign the CLA" section of the page to point to current working pages.
2018-10-30 16:54:33 -07:00
Tim Fogarty 9abeb8bfa1 Update PR template for 1.13 release (#10603)
* Update PR template for 1.13 release

Also updates links to documentation for submitting PRs

* Update contributing docs for new branch strategy

Branches for upcoming releases are now dev-X.Y instead of
release-X.Y
2018-10-12 18:00:20 -07:00
Justin Clift a628b58096 Trivial typo fixes (#10386) 2018-10-03 19:37:52 -07:00
Qiming 26f0a81b65 Rework tool/doc for updating reference docs (#10123)
* WIP - rework update imported docs

* Rework tool/doc for updating reference docs

This PR reimplement the reference docs generator in Python and fixes
some outdated docs and data:

- Do docs import using Python because the GoLang version of tool has
  some following drawbacks:
  * its not convenient for handling YAML config files
  * it has to be compiled to binaries to run on different platforms
  * for every tiny changes you need to compile a new version and check in
- The reference docs we use in website are actually not coming directly
  from `kubernetes/kubernetes`. Most of them come from the `reference-docs`
  project. The configuration files are thus changed to avoid confusion.
- We have changed the location of generated docs so the default configuration
  files and the docs are updated.
2018-09-21 14:08:50 -07:00
AdamDang 80d4b6faea Typo fix: Kubnetes->Kubernetes (#10128)
Typo fix: Kubnetes->Kubernetes
2018-08-29 10:18:04 -07:00
Sam Foo 22f1f28bfa Remove imported/ references (#10004)
Signed-off-by: GuessWhoSamFoo <sfoohei@gmail.com>
2018-08-21 15:54:33 -07:00
shavidissa e3f0158b5d Minor changes (#9938)
Minor fix and added the html escapes for <>.
2018-08-20 14:01:22 -07:00
Sam Foo 13184cac84 Fix indentation and Code of Conduct link in contribute section (#9896)
Signed-off-by: GuessWhoSamFoo <sfoohei@gmail.com>
2018-08-18 06:51:06 -07:00
Sam Foo a89faee491 Fix Custom Hugo Shortcodes link (#9881)
Signed-off-by: GuessWhoSamFoo <sfoohei@gmail.com>
2018-08-16 20:12:09 -07:00
Misty Linville 5ae0d0dd8d Reorganize docs contrib guide (#9510)
* Reorganize docs contrib guide

* Address first round of feedback from Brad, Jared

* Standardize on 'SIG Docs'

* Address more feedback

* Rewrites to participating.md

* Tweak navigation titles

* Document PR Wrangler

* Document SIG Docs chairperson

* Fix codeblock that shows how to use <codenew>

It was being interpreted as a Hugo shortcode.
2018-08-06 16:15:57 -07:00