Commit Graph

122 Commits (4c48c963a0d7e4a12b8d8d7d664922799d09da38)

Author SHA1 Message Date
aimeeu 99895de868 Update work from a local clone section (#16748)
Add content based on Slack thread
https://kubernetes.slack.com/archives/C1TU9EB9S/p1570736679005700

Change -f to --force-with-lease
Simplified wording

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-27 10:11:24 -07:00
Karen Bradshaw f29d3153eb rename reference/kubernetes-api/index (#16947)
- renamed docs/reference/kubernetes-api/index.md
- added weight to files in docs/reference/kubernetes-api
- attempt to clean up labels-annotations-taints.md
- updated _redirects file
2019-10-23 08:48:16 -07:00
Zach Corleissen b894856e8e Update how to run Hugo locally (#16982) 2019-10-23 08:26:19 -07:00
Yuk, Yongsu d437e8c6bc en: Change the full link in the document to an inline link. (#17057)
* Change the full link in the document to an inline link.

grep -r "https \: \ / \ / kubernetes \ .io" content/en/docs
Changed to inline link except the following list.
- URLs are mentioned directly in the body
- release note
- url to blog
- url to community
- Url to be redirected

* Apply suggestions from code review

Co-Authored-By: June Yi <june.yi@samsung.com>
2019-10-23 06:20:14 -07:00
aimeeu 04127a3acb Update script for Python3, PyYAML 5.1.2 (#17127)
-Update to use argparse.ArgumentParser() for command line args
-Use tempfile library to create tmp work directory

-Remove shutil.rmtree because it was throwing permission errors and
not deleting the directory. Also no longer needed after switching
to tempfile.

-Enchance error handling
-Add check for Go installation
-Enhance check for PyYAML installation
-Change deprecated PyYAML load function to full_load
-Add comments at top of file
-Modify to comply with PEP8
-Update kubernetes-components.md with software versions to match script

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-22 14:04:18 -07:00
aimeeu b1bd43f9d7 Update how to use the update-imported-docs tool (#16777)
Update kubernetes-components.md with software versions.
Move content from README to kubernetes-components to avoid duplication.
Be listed in the `kubernetes/website/data/reference.yml` file

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-10-14 16:19:52 -07: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
PingWang 74397dd65f Add the -n for pod in kubectl command (#16798)
Signed-off-by: PingWang <wang.ping5@zte.com.cn>

Add instructions in kubectl command

Signed-off-by: PingWang <wang.ping5@zte.com.cn>

update

Signed-off-by: PingWang <wang.ping5@zte.com.cn>
2019-10-11 18:28:39 -07:00
Abhishek Mane a909352ac6 feature added for issue #16771 (#16802)
* feature added for issue #16771

* Update intermediate.md
2019-10-11 15:10:04 -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
Roy Hvaara b1cc4d982b Fix broken link to Documentation style overview from Contribute page (#16667) 2019-10-02 13:58:08 -07:00
Jim Angel 0044acb69a reflecting k8s-sig migration (#16632) 2019-10-02 11:46:07 -07:00
aimeeu bd7308274e Update reference-docs repo (#16622)
reference-docs moved from kubernetes-incubator to kubernetes-sigs

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-09-30 12:42:46 -07:00
aimeeu e2da611c77 Enhance Triage and categorize issues section (#16295)
Enhance to emphasize that triagers should add a priority to each
issue.
Add Learn about Prow section

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-09-25 08:54:01 -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
Karen Bradshaw 444ef3486e add processing of kubectl cmd links (#16529)
- add processing of kubectl links in update-imported-docs.
- update component reference generation guide.
- For more information, see issue #16454.
2019-09-24 00:59:25 -07:00
Praveen Sastry b2d803d71e Rename `Flexvolume` to `FlexVolume` in docs (#16333) 2019-09-12 09:42:27 -07:00
savitharaghunathan 8f2d392fb5 Updating style.md and write-new-topic.md with markdowns (#16190) 2019-09-11 18:08:38 -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
Jared a02fea5330
Update link 2019-08-13 09:20:16 -07:00
Jared efed54c79a
Fixed broken link 2019-08-13 09:18:43 -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
Zach Corleissen 9591ca0957 Tiny typo fix (#15579) 2019-07-30 08:50:53 -07:00
Zach Corleissen ce8fc52fef Add closure guidelines (#15261)
Add close command

Add a note about fejta-bot

Feedback from kbhawkey
2019-07-14 05:17:03 -07:00
Karen Bradshaw 997242c871 clean up label comments (#15397) 2019-07-13 11:03:04 -07:00
Zach Corleissen 0e540e8dcb Update contribution guidelines for approvers (#15385) 2019-07-12 16:25:04 -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
Ellen Mei ec61bf6c84 machine-generated translations need human review (#15381) 2019-07-11 11:13:06 -07:00
Karen Bradshaw 48e68a9eb5 Update api reference contrib doc (#15114)
* Update api reference contrib doc

See issue #14111

* updates to api ref contrib guide

* further updates to api ref contrib

* more updates api ref contrib
2019-07-06 21:00:34 -07:00
zhangqx2010 42ef78a7ad update multi-language description (#15124)
* update multi-language description

* Update style-guide.md

* Update style-guide.md
2019-07-06 20:56:34 -07:00
Karen Bradshaw 0c4353e86c update kubectl ref contrib guide (#15199)
* [WIP] update kubectl ref contrib guide

* updates to kubectl cmd ref contrib
2019-07-06 04:54:35 -07:00
Tim Bannister ca9e44ff9c Tidy reference doc generation guide (#14825)
- fix YAML marked as shell
- trim trailing whitespace
2019-06-16 18:04:07 -07:00
Rajakavitha1 f7d6afedec Add accessibility guidelines to the style guide (#14292)
* [WIP] added accessibility guidelines to the style guide

Adopted the accessibility level A and AA guidelines to Markdown elements: 
https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0&currentsidebar=%23col_overview&levels=aaa

We still need to define attributes for the front matter. See, https://github.com/kubernetes/website/issues/14286

I am yet to draft the guidelines for images and alt text.

* fixed the note

Update style-guide.md

Incorporated the changes suggested

Incorporated the changes suggested.

fixed the formatting  issues in the table

fixed the spaces in the links section

fixed a space issue

fixed format issues in the link

added a11y guidelines to code section

removed a spacing issue

front matter guidelines best fit the using template section

Update content/en/docs/contribute/style/style-guide.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/contribute/style/style-guide.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Update content/en/docs/contribute/style/style-guide.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

incorporated the changes

incorporated the changes

Update content/en/docs/contribute/style/style-guide.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

title section for front matter guideline

updated the html characters

Update content/en/docs/contribute/style/style-guide.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Update style-guide.md
2019-06-10 20:32:15 -07:00
codyc 1b9af9ad50 Federation Remediation Part Deux (#14140)
* first removal of federation

* more fixes
2019-06-10 17:32:15 -07:00
Luc Perkins 654db85168 Use Hugo extended for Sass/CSS (#13113) 2019-06-09 06:31:07 -07:00
Karen Bradshaw 88fe150abc clean up feature state examples, style guide (#14699) 2019-06-03 17:49:02 -07:00
Karen Bradshaw c66db29c11 update link to front matter description (#14493)
Update the front matter link from jekyll to gohugo.
2019-05-24 03:04:20 -07:00
June Yi 18367feaea Describe language specific style guide in l10n guide (#14437) 2019-05-21 01:12:41 -07:00
Franklin Yu da9d0da028 Fix code block (#14334) 2019-05-16 04:59:42 -07:00
Yang Li 38fcbeb49c updated the links of cherrypick guide (#14348) 2019-05-16 04:51:43 -07:00
Zach Corleissen caca9c6976 Add co-chair role (#14219)
Add meeting guidelines, graphic

Update embedded image

Use raw HTML for image link

Edit path

Indent list items

minor edits

Add line breaks for indentation

Add bolding

Add section for meetings

Feedback from jimangel
2019-05-15 18:19:43 -07:00
Rajakavitha1 0b8b595805 Update advanced.md (#14158)
Deleted the additional (https://) that was resulting in a broken link.
2019-05-04 18:11:36 -07:00
shavidissa 84fe95e2ef Update advanced.md (#14092)
* Update advanced.md

Updated the content as per issue: https://github.com/kubernetes/website/issues/13864. Organized and merged the content that was originally on this page and on the wiki (https://github.com/kubernetes/website/wiki/PR-Wranglers).

* Removed extra spacing

Removed an additional white space that was in place.

* Minor copy-edit changes

* Updated as per the comments.
2019-04-30 11:24:57 -07:00
Rael Garcia e91df53ef7 Add Setting up the OWNERS files section (#13912)
* Add Setting up the OWNERS files section
* Update OWNERS_ALIASES patch
* Replace owners.md link with go.k8s.io/owners
* Replace github.com/kubernetes link with git.k8s.io
* Update OWNERS_ALIASES to use git.k8s.io link
* Sort patch diff in alphabetical order
* Specify clearly what teams should be added
* Remove the passive voice
* Complete alphabetical order phrase
2019-04-29 15:51:38 -07:00
Jared ba48dd0c7e
Added additional information about contributing to K8s
Split out docs contributions from feature and community contributions per user feedback.
2019-04-26 15:23:15 -07:00