Commit Graph

454 Commits

Author SHA1 Message Date
Naeil ZOUEIDI 2fcdf70154 Adding #pr-reviews to the contributor guide
Adding the #pr-reviews as a note
2019-03-14 05:07:49 -04:00
guineveresaenger c25d393d52 Adds list of SIG specific contributor guides (with links) to generic contributor guide 2019-03-13 10:56:36 -07:00
Michael Michael db0a193383
Update README.md 2019-03-13 11:21:47 -05:00
Michael Michael 4d24bba4d1
Update README.md 2019-03-13 11:20:55 -05:00
Michael Michael 90a89d05d5
Delete contributing-on-windows.md 2019-03-13 11:19:27 -05:00
Michael Michael 2b6fb0f375
Update contributing-on-windows.md 2019-03-12 21:52:21 -05:00
Michael Michael 678269443f
Update contributing-on-windows.md 2019-03-12 21:41:54 -05:00
Michael Michael b60a31b80a
Update contributing-on-windows.md 2019-03-12 21:41:21 -05:00
Michael Michael d221f13bc2
Update README.md 2019-03-12 19:35:59 -05:00
Michael Michael f061cd3175
Create contributing-on-windows.md 2019-03-12 19:23:25 -05:00
Kubernetes Prow Robot 050c43e77e
Merge pull request #3405 from nzoueidi/master
Mention contributor playground in the contributor guide
2019-03-12 12:14:39 -07:00
Naeil ZOUEIDI e67ea2b1cd Mention contributor playground in the contributor guide
update README.md

Fixing a sentence
2019-03-12 19:31:42 +01:00
Gábor Finta 7371f184e4 Fix typo in contributors guide 2019-03-12 09:24:16 +01:00
Bob Killen 8acf9eafcb
Update heading guidelines in style guide. 2019-03-11 20:02:04 -07:00
Joel Smith 2f922a12b1 Rename Product Security Team to Committee 2019-03-04 11:47:21 -07:00
Nikhita Raghunath 8b65a66aa7 Update CoC links to the Kubernetes CoC instead of the CNCF CoC 2019-02-08 19:14:00 +05:30
eduartua 4644fb47e7 all URL pointing to kubectl-conventions.md have been fixed 2019-02-06 16:22:26 -06:00
Kubernetes Prow Robot cc53611b44
Merge pull request #3195 from qedrakmar/master
Update Documentation for Non-Code Contributions Guide and Meeting
2019-02-05 14:46:07 -08:00
ramnar a095f16dc8 Broken Links fix for 2696 (#3171)
* broken links fix in kubernetes community

* Broken Links bug fix

* Implemented Review Comments

* Implemented Review Comments
2019-02-05 06:44:42 -08:00
Noah Abrahams e9c931bada Added community input to the non-code-contributions guide, and added a link to that guide from the Contributor Guide. 2019-02-03 22:39:32 -08:00
eduartua 0bacd3d192 Some files had conflict with some URL - fixed now 2019-01-31 13:36:01 -06:00
Kubernetes Prow Robot 380e6a81c3
Merge pull request #3172 from rlenferink/patch-1
Updated OWNERS files to include link to docs
2019-01-30 20:56:37 -08:00
Kubernetes Prow Robot 74ff7245e8
Merge pull request #3125 from mrbobbytables/style-guide
Documentation style guide
2019-01-30 20:46:52 -08:00
eduartua 06a2a2f686 file testing.md moved to the new folder /devel/sig-testing - URLs updated - tombstone file created 2019-01-30 13:26:54 -06:00
eduartua af988769d2 e2e-test.md file moved to the new /devel/-sig-testing folder - URLs updated - tombstone files created 2019-01-30 12:55:10 -06:00
Roy Lenferink 4396a8b7f3 Updated OWNERS files to include link to docs 2019-01-30 19:37:21 +01:00
Bob Killen 75752cc3b6
Add documentation style guide. 2019-01-30 07:23:21 -05:00
Kubernetes Prow Robot 1d747b3720
Merge pull request #3162 from eduartua/issue-3064-grouping-by-sig-instrumentation
Grouping  /devel files by SIGs - SIG Instrumentation
2019-01-29 14:29:33 -08:00
eduartua f684fcb8df file release.md has been moved to /devel/sig-release - URLs in k/community updated 2019-01-29 11:23:48 -06:00
eduartua 3368adb2cc /devel/sig-release folder created - file cherry-picks.md moved to /devel/sig-release - URLs updated 2019-01-29 11:03:22 -06:00
eduartua 9cfd840e1c file logging.md was moved to the new sig-instrumentation folder - URLs in k/community were updated 2019-01-28 14:45:07 -06:00
eduartua 1e4beeda12 URLs changed from abs path to relative path 2019-01-28 13:31:30 -06:00
guineveresaenger 350a522118 Add guineveresaenger to OWNERS files in contributors
I would like to assist as a Reviewer in the rebuilding of our developer guide. I also think I might be of assistance approving contributor guide related issues.
2019-01-24 22:13:04 -08:00
eduartua 06207d2363 Created tombstone files for files moved to /devel/sig-architecture - URLs updated in k/community 2019-01-24 16:48:03 -06:00
eduartua aec3053035 Grouping files by sig-architecture - fixed links 2019-01-24 11:57:12 -06:00
Christian Simon 6152d6a57e Fix cherry-pick link 2019-01-19 11:19:09 -05:00
Kubernetes Prow Robot 432bd8e9a4
Merge pull request #3101 from eduartua/issue-3064-3
Moving contributors/devel/help-wanted.md to contributors/guide-  Issue 3064 3
2019-01-15 20:52:58 -08:00
eduartua d5e5c2b3fa Updated URL in contributors/guide/README.md
Updated URL in contributors/guide/issue-triage.md

Updated URL in communication/meeting-notes-archive/q1-2_2018_community_meeting_minutes.md

Moved help-wanted from /devel to contributors/guide

Created tombstone for help-wanted.md
2019-01-15 16:35:44 -06:00
eduartua a156dd1034 Created tombstone file for /devel/collab.md - updated URL in other files 2019-01-15 13:45:03 -06:00
Nguyen Hai Truong 575986abe3 Fix typo in Figure Github workflow
Modify a typo in "After Step 7, if has...":

futher -> further
2018-12-02 23:35:11 -08:00
Nguyen Hai Truong bb058946a8 Update more detail of Github workflow
Adding more detail of: $ git commit --amend
2018-11-30 02:19:35 -08:00
Nikhita Raghunath 30cdbf9298 issue triage: add help-wanted and good-first-issue details 2018-11-22 14:50:24 +05:30
k8s-ci-robot 1560c15d42
Merge pull request #2870 from ignertic/patch-1
Add Meet Our Contributors link
2018-11-19 20:53:45 -08:00
Riya 5df541ee60 Update contributors guide README.md 2018-11-12 16:46:26 +05:30
ignertic b67fb8cc44
Update README.md 2018-11-12 02:47:10 +02:00
Michiel Rook 7894b85422
Fix typo 2018-11-06 14:48:21 +01:00
Tim Allclair (St. Clair) bfe63f118c
Fix plugin links in owners documentation 2018-11-05 15:13:14 -08:00
ignertic 08fd17f08b
Add Meet Our Contributors link 2018-10-29 12:04:15 +02:00
eduartua 9f4632d9a7 Conformance of the names of the conferences file: contributors/guide/non-code-contributions.md 2018-10-25 20:26:19 -05:00
Chris Hoge e4640f049e Clarify the use of lgtm and approve labels
Clarify the use of lgtm and approve labels, and call out special
cases which may result in surprising behavior by the code review
system.
2018-10-24 17:31:23 -07:00
k8s-ci-robot 9fa150d5b6
Merge pull request #2339 from marpaia/update-adding-relnotes-guide
Update the release notes guide to reference recently added labels
2018-10-23 08:25:30 -07:00
Carolyn Van Slyck 98964d5aaf Update Code of Conduct page with new email (#2806)
* Update Code of Conduct page with new email

Now that we have a Code of Conduct Committee for Kubernetes, people should
contact our private email list going forward with any problems.

* Incorporate review feedback
2018-10-16 10:28:04 -07:00
k8s-ci-robot dc829aac36
Merge pull request #2764 from SataQiu/fix-20181008
fix typo
2018-10-10 09:51:18 -07:00
SataQiu b6d113dff0 fix typo 2018-10-08 19:44:11 +08:00
Nikhita Raghunath c2bd5cb839 Replace submit queue with Tide in docs 2018-10-06 23:08:24 +05:30
k8s-ci-robot 0d0b05209a
Merge pull request #2620 from tallclair/vrp
Initial bug-bounty scope
2018-09-28 10:58:05 -07:00
Tim Allclair eda13ca236
Initial bug-bounty scope 2018-09-28 10:25:47 -07:00
Arnaud Meukam 46ded5d187 add the redirection for the good first issues 2018-09-27 03:15:51 +02:00
Jorge O. Castro f570f458fe
Replace kubernetes-users mentions with new location 2018-09-17 08:32:02 -04:00
Mike Arpaia 9160d9b784
Update the release notes guide to reference recently added labels 2018-09-12 09:10:00 -06:00
Josh Berkus 8c662f7306 Add suggestions for Event-related contributions to the noncode guide 2018-09-05 13:42:23 -07:00
k8s-ci-robot 689654f4aa
Merge pull request #2607 from idvoretskyi/idvoretskyi-slackarchive-rm
README.md updated - slackarchive removed
2018-08-31 09:29:29 -07:00
Tim Pepper e8f9f2a0ef devel guide: pull in issue doc from sig-release/ephemera
The sig-release repo has a set of old documentation looking for a
better home.  The issues.md document there describes how a developer
targets an issue (or PR) to a milestone release.  This logically
fits better in the community/contributors/devel/ guide, so this commit
brings it in and a parallel commit will remove it from the other repo.

With it comes two pictures of what a release cycle and the overall
release lifecycle look like.

The issues.md content is modified a bit to add more information
about the release process overall and remove outdated information
around the bot-driven workflow for targeting work to a milestone, and is
named release.md here.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-08-30 17:35:05 -07:00
Tim Pepper 0ebcc778e3 contrib guide: update link
The SIG-Release ephemera on issue workflow is moved to the devel guide.
Updating reference to it.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-08-30 17:28:32 -07:00
Ihor Dvoretskyi 8b68c72a17 Squashed commit of the following:
commit 7bebc93039
Author: Ihor Dvoretskyi <ihor@linux.com>
Date:   Thu Aug 30 14:44:23 2018 +0000

    sig-governance.md updated

    Signed-off-by: Ihor Dvoretskyi <ihor@linux.com>

commit ee0f24313f
Author: Ihor Dvoretskyi <ihor@linux.com>
Date:   Thu Aug 30 14:43:47 2018 +0000

    contributors/guide/issue-triage.md updated

    Signed-off-by: Ihor Dvoretskyi <ihor@linux.com>

commit 09bc3f6d9b
Author: Ihor Dvoretskyi <ihor@linux.com>
Date:   Thu Aug 30 14:42:38 2018 +0000

    README.md updated

    Signed-off-by: Ihor Dvoretskyi <ihor@linux.com>

commit 5b4146f10d
Author: Ihor Dvoretskyi <ihor@linux.com>
Date:   Thu Aug 30 14:26:51 2018 +0000

    README.md updated - slackarchive removed

    Signed-off-by: Ihor Dvoretskyi <ihor@linux.com>
2018-08-30 14:56:24 +00:00
k8s-ci-robot 265a466722
Merge pull request #2596 from wking/owners-filters
contributors/guide/owners: Document OWNERS' 'filters' key
2018-08-29 20:22:57 -07:00
Jonas Rosland 3450708f13 Adding more details into the non-code contributor guide roles
Corrected italics
2018-08-29 15:08:12 -07:00
W. Trevor King 99f251cbca contributors/guide/owners: Document OWNERS' 'filters' key
Catching up with kubernetes/test-infra@e8c6b7f1 (Add OWNERS file
support for regexp filters, 2018-01-08, kubernetes/test-infra#6411).

The relative-path assertion is based on Cole's comment [1].  The
sibling limitation is based on Cole's comment [2].

[1]: https://github.com/kubernetes/community/pull/2596#discussion_r213768438
[2]: https://github.com/kubernetes/community/pull/2596#discussion_r213788099
2018-08-29 12:47:42 -07:00
Tobias Nehrlich 15c88b5b96 Adds the 'trivial edit contribution policy'
Added the text from #1628 under 'Best Practices for Faster Reviews' and linked it at the top of the document.

Issue: #1628
2018-08-26 23:02:12 +02:00
Will Hayslett 85c3d5fc2d
Corrected contributor guide readme
Removed superfluous "for" in the "Find something to work on" section
2018-08-22 22:16:27 -05:00
Jorge O. Castro bc980554ce
Add link to the role board 2018-08-22 15:26:15 -04:00
Gergely Csatari 7346c91707 Adding a reference to the OWNERS_ALIASES description
In the buletpoint where the manual pr assgnement is described there is
no reference to the description how OWNERS_ALIASES and OWNERS files
are related. This pr adds a reference to the description.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-08-17 11:48:05 +02:00
k8s-ci-robot 72cb7f2c03
Merge pull request #2444 from castrojo/remove-guide-disclaimer
Remove disclaimer and do one more round of copyediting
2018-08-01 14:31:56 -07:00
Cheryl J. Hung 4ac6054c5b
Fix broken link 2018-08-01 21:49:56 +01:00
Jorge O. Castro 3a67939608
Remove disclaimer and do one more round of copyediting
Add review fixes from Guin
2018-08-01 15:30:11 -04:00
Jeffrey Sica bb220cc04a add section on prs being held up by release cycle 2018-07-30 17:19:31 -04:00
Aaron Crickenberger 0e31a17666 Remove mentions of priority/failing-test 2018-07-23 15:10:55 -07:00
k8s-ci-robot 2d2feabc33
Merge pull request #1867 from brahmaroutu/conformance
Adding Conformance Guidelines document.
2018-07-23 14:46:39 -07:00
Sahdev P. Zala 198442b315 Mention fejta bot in the triage guidelines
Since the fejta bot now actively triaging and closing issues, we should
mention it in the triage guidelines and if it has any impact on the usage of
the guidelines for closing issues. It should be helpful to anyone referencing
the guidelines specially to the new triagers.
2018-07-23 16:09:16 -04:00
Sahdev P. Zala 0ebfd53d95 Use the triage support label
The kind/support is replaced with triage/support label, so replace references
accordingly.
2018-07-21 15:00:10 -04:00
Srini Brahmaroutu a08ccca618 Adding Conformance Guidelines document. 2018-07-20 13:01:25 -07:00
Palash Nigam de9b4257e6
Contributors guide: Clarify repository specific guidelines
Closes https://github.com/kubernetes/community/issues/1833
2018-07-19 12:36:29 +05:30
k8s-ci-robot bf2b6f244a
Merge pull request #2327 from castrojo/non-developers
Add non-developers contribution section and an owner for it
2018-07-17 08:58:40 -07:00
Jorge O. Castro a0b45a884d Add a list of handy email aliases 2018-07-13 12:35:49 -07:00
Jorge O. Castro d257c8974c Add non-code contribution section and two new owners for it 2018-07-13 12:33:03 -07:00
k8s-ci-robot fbd425b5ee
Merge pull request #2346 from guineveresaenger/assignment
Adds explanation for inability to assign non-org members to Issues to…
2018-07-09 16:33:04 -07:00
Bob Killen 18ccfff289
update kubernetes.io urls 2018-07-08 20:23:54 -04:00
guineveresaenger 72752135fd Rewords the actions to be taken by nonmember to indicate ownership of an issue 2018-07-05 13:41:27 -07:00
guineveresaenger 40c826de67 Adds explanation for inability to assign non-org members to Issues to contributor guide 2018-07-05 11:56:36 -07:00
k8s-ci-robot d7dee0262c
Merge pull request #2320 from castrojo/security-mention
Add an initial security section
2018-07-02 16:44:17 -07:00
kevinlmadison 8558e4f730 Fix grammatical error in testing section of the contributing guide. 2018-06-29 22:24:12 -04:00
Nikhita Raghunath 828625ac89 contributor guide: document the revert process 2018-06-28 19:42:59 +05:30
Jorge O. Castro 9263c1547f
Fix spelling. 2018-06-27 14:24:32 -04:00
Conor Landry 6d3c337df3 add a notice that the good first issue label is new and a WIP 2018-06-12 14:34:58 -04:00
k8s-ci-robot ef38c64a4b
Merge pull request #2226 from carolynvs/clarify-help-wanted-first-pr
Document "good first issue" label
2018-06-09 15:38:59 -07:00
Carolyn Van Slyck 742a0445d6
Define good first issue and clarify help wanted labels 2018-06-09 17:21:55 -05:00
Andreas Jaeger d9989e9817 Fix link to Prow commands
https://github.com/kubernetes/test-infra/blob/master/commands.md
redirects now to https://prow.k8s.io/command-help . Update the
documentation so that we link directly to
https://go.k8s.io/bot-commands as better automatic redirect.
2018-06-07 22:42:55 +02:00
Nikhita Raghunath a31e84ce51 Update links in contributor cheatsheet 2018-06-02 11:38:54 +05:30
k8s-ci-robot dd2f4cc060
Merge pull request #2136 from gerl1ng/EventChina
Add China to the list of events
2018-05-14 10:03:27 -07:00
Marius Gerling 8ccff61002 Add China to the list of events
KubeCon + CloudNativeCon is now held thrice a year.
China is added to the list of events.

Signed-off-by: Marius Gerling <marius@gerl1ng.de>
2018-05-14 11:22:55 +02:00
austin 6278096d53 Adds WHAT env variable description
When contributing specific parts of k8s, its helpful to know how to slice the build to only build a certain binary.
2018-05-11 09:03:36 -07:00
k8s-ci-robot 668e18ca48
Merge pull request #1970 from spzala/triagelabels
Describe new labels in triage guidelines
2018-04-19 15:56:59 -07:00
Sahdev P. Zala 38124eed5b Describe new labels in triage guidelines
Recently we have added new labels to identify issues that are candidates for close.
These issues are typically the one which are not goint to close via a fix. Add
description in triage guidelines about when to use these labels.
Related PR is,
kubernetes/test-infra#7554
2018-04-16 17:45:27 -04:00
Tim Pepper 0da18de1ec update issue triage doc url
The issue triage doc has moved from:
	contributors/devel/issues.md
to:
	contributors/guide/issue-triage.md

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-04-10 10:07:38 -07:00
k8s-ci-robot 9931cbdd8d
Merge pull request #2007 from castrojo/add-code-site
Add code search and contributor guide, remove reviewable
2018-04-10 08:57:09 -07:00
Vijay Mateti eebd98b8ef
Fix for duplicate title on Contributors guide README 2018-04-09 11:17:02 -04:00
Sahdev P. Zala 64ac525c3c Describe new labels in triage guidelines
Recently we have added new labels to identify issues that are candidates for close.
These issues are typically the one which are not goint to close via a fix. Add
description in triage guidelines about when to use these labels.
Related PR is,
https://github.com/kubernetes/test-infra/pull/7554
2018-04-06 16:11:56 -04:00
Patrik Erdes 8798cc13a6 Change 'Mac OS X' and OS X' to 'macOS'
Mac OS X was renamed to OS X in 2012, and then renamed again to macOS in 2016.
I suggest that the current name (macOS) should be used whenever referencing the Apple OS.
2018-04-06 08:31:45 +02:00
Van Tu b41b8a759f
Fix a typo 2018-04-05 21:35:06 -04:00
Jorge O. Castro 87d6b65e2b
Add a link to @dims profile 2018-04-05 15:29:13 -04:00
Jorge O. Castro 6287fcddd8
Make it clear who maintains the k8s code search site 2018-04-05 15:27:50 -04:00
Jorge O. Castro c993e57824
Add code search and contributor guide, remove reviewable 2018-04-05 14:22:03 -04:00
Juan Jimenez 89abb7f4ce
Hate it when I miss a tiny error. 2018-03-23 12:55:22 +01:00
Juan Jimenez 866da59df1
Fixing table of contents section 2018-03-23 12:54:25 +01:00
Juan Jimenez 6d6aede51a
Small changes 2018-03-23 12:17:45 +01:00
Juan Jimenez e7973af591
Responding to a few more change requests 2018-03-20 17:56:51 +01:00
Juan Jimenez c4081c556f
Update document in response to change requests 2018-03-20 09:55:53 +01:00
Juan Jimenez f4222fe20f
Update scalability-good-practices.md
Edited for grammar, sentence structure, punctuation and general clarity.
2018-03-19 19:06:34 +01:00
bin liu 261cb0fd08 Change k8s-merge-robot to k8s-ci-robot 2018-03-15 06:48:54 +08:00
Mohammad Riftadi a99ea22418 update pointer the bot commands to a flexible url 2018-03-05 09:22:05 +01:00
Christoph Blecker d5b9d92fd6
fix a typo in the Contributor Guide readme 2018-03-03 14:10:52 -08:00
Ellen Körbes f9efbe89e8 CNI link 2018-02-25 16:19:40 -03:00
Ellen Körbes 626c637b33 quick fixes 2018-02-25 11:32:57 -03:00
k8s-ci-robot 16ee8b3c7c
Merge pull request #1841 from castrojo/mention-membership
Add mention of membership roles to contrib guide
2018-02-23 10:42:44 -08:00
Jorge O. Castro 2138c03113 Fix roles ToC entry 2018-02-23 13:05:10 -05:00
Jorge O. Castro e0fafcdf23 Fix TOC, add encouragement to level up 2018-02-23 12:01:16 -05:00
k8s-ci-robot ead946a8e0
Merge pull request #1761 from guineveresaenger/pullrequests
Cleanup and move to /contributors/guide of pull requests doc
2018-02-22 15:35:42 -08:00
guineveresaenger 405849f487 Release Notes: Title added; minor cleanup. Faster reviews tombstone added. Minor cleanup in pull-requests.md 2018-02-22 14:42:13 -08:00
guineveresaenger 66eb35601d Explains how to assign a reviewer using a bot command
Pinging someone with a github mention is different from using a bot command to assign them as a reviewer. This commit includes a specific explanation.
2018-02-22 14:42:13 -08:00
guineveresaenger 313ded24d3 Fixes table, capitalization, and in-doc links
This addresses a few broken links that resulted from style changes.
2018-02-22 14:41:57 -08:00
Jorge O. Castro 40863e00d0 Add mention of membership roles to contrib guide 2018-02-22 15:19:36 -05:00
Alejandra Bustos 4f755b398a Complete Install etcd in GitHub Workflow 2018-02-21 12:39:40 -06:00
guineveresaenger c990f670d2 Adding release-notes.md as separate file.
If a contributor reads the pull request template upon creating a PR then
they will get hints, but ahead of a PR there has not been sufficient
documentation of when release notes are required for a change, how a
contributor should indicate that a change needs notes, or what the note
text should be.  To help address this, this commit adds a first set of
release notes documentation for reference by the contributor guide.
2018-02-19 21:21:58 -08:00
guineveresaenger 28c2c5f4d4 Fixing links
Links now point at new location for pull-requests.md.
2018-02-19 21:21:58 -08:00
guineveresaenger f71f80ce56 Major rewrite of pull request process
The pull-requests.md document has gotten quite out of date.  This commit
does a massive scrub of its content for completeness, accuracy and
readability.  A number of links are fixed, updated information on labels
and bot commands is added, workflow descriptions for test and merge are
updated, and a description of the KEP process is added.
2018-02-19 21:20:17 -08:00
guineveresaenger 98bea78a76 contrib guide: move pull-requests.md from devel/ to guide/
Understanding the pull request process is central to being a successful
contributor.  This commit moves it from the more technical k8s internals
detailed devel/ area over to the guide/ where it will get more
visibility.
This patch just moves the file and leaves a tombstone reminder
behind.
2018-02-19 21:20:17 -08:00
guineveresaenger aeb13f90c2 This commit removes the duplication of thanks from the Contributor Guide
Thanks were expressed twice in the Contributor Guide. To remove clutter, this pull request removes this section from the main README but leaves it in community-expectations.md. In the future, code review documentation will be added as well.
2018-02-15 13:48:21 -08:00
Jorge O. Castro 6d9820bf93 Move scalability good practices to the contributor guide 2018-02-08 14:15:18 -05:00
Jorge O. Castro 02a00faf53 Move owners file to the contributor guide
Added a new section in the README for things that are important for
contributors to know, but not something they will use often or at all
but needs to be documented, like owners files.
Linked to documentation team's contribution page.
2018-02-08 10:24:39 -05:00
k8s-ci-robot 58d176b501
Merge pull request #1741 from guineveresaenger/sig-label-example
Contains example for adding a SIG label
2018-02-06 04:18:11 -08:00
Tim Pepper 6092312009 contrib guide: update ToC
The table of contents has slipped out of date.

FYI I'm generating a ToC with a command like:
	pandoc -t markdown_github --toc -s README.md
and then picking up the modifications and dropping them in the document.

Not the best workflow, but..markdown.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-02-05 17:34:45 -08:00
guineveresaenger 7045c6066f removed KubeCon stub - information is present under Events 2018-02-05 11:07:29 -08:00
guineveresaenger c09259b656 adding meetup information 2018-02-05 11:02:41 -08:00
guineveresaenger 4a1c527d90 adds link to mentoring README 2018-02-05 10:28:03 -08:00
guineveresaenger d3b163a214 Contains example for adding a SIG label 2018-02-05 09:59:05 -08:00
Christoph Blecker b50b500cab
Add some labels to directory OWNERS files 2018-02-04 19:56:02 -08:00
k8s-ci-robot 04bc9fd717
Merge pull request #1730 from castrojo/add-toc-headers
Add TOC headers to contributor, developer, and mentorship guides
2018-02-03 06:23:05 -08:00
Jorge O. Castro df19571fd4 Add TOC headers to contributor, developer, and mentorship guides
This adds the necessary metadata to generate a table of contents when
when generating these pages for the documentation.
2018-02-02 13:16:21 -05:00
Jorge O. Castro 05de74cba3 Add pointer to communication/
Communication resources are in their own directory, this points people
to it.
2018-02-02 12:07:36 -05:00
Ihor Dvoretskyi 8322ec6499
Updated k8s devstats link
Even the existing one is working, the updated is more correct.
2018-01-30 17:08:33 +02:00
k8s-ci-robot 05ccea37f2
Merge pull request #1694 from castrojo/move-issue-triage
Move issue triage guide into the contributor guide
2018-01-29 17:11:06 -08:00
k8s-ci-robot 9e403b7366
Merge pull request #1703 from cblecker/guide-owners
Add OWNERS file for contributors/guide/
2018-01-29 16:51:06 -08:00
k8s-ci-robot bf045f015c
Merge pull request #1701 from halfcrazy/fix/typo-contributors-guide
doc: fix typo in contributors guideline.
2018-01-29 16:10:33 -08:00
zhuyan 06b3a38988 doc: fix typo in contributors guideline. 2018-01-30 05:32:22 +08:00
Christoph Blecker d06162ee52
Add OWNERS file for contributors/guide/ 2018-01-29 09:27:10 -08:00
k8s-ci-robot 1914daacf1
Merge pull request #1697 from guineveresaenger/morelinks
fixing more links
2018-01-29 06:22:32 -08:00
Moshe Immerman 303a0a8185
fix: broken link to community-expectations.md 2018-01-28 12:33:45 +02:00
guineveresaenger c4d6cdcf61 fixing more links 2018-01-26 14:24:57 -08:00
k8s-ci-robot c41473c9d7
Merge pull request #1695 from guineveresaenger/brokenlink
fixed links to community expectations
2018-01-26 08:21:31 -08:00
guineveresaenger ec8afcb362 fixed links to community expectations 2018-01-26 08:16:34 -08:00
Jorge O. Castro 226adc4ea9 Add issue-triage to the main guide 2018-01-26 10:39:39 -05:00
Jorge O. Castro d8bbdba62c This moves the issue triage guide into the contributor guide 2018-01-26 10:33:53 -05:00
Tim Pepper b75e54d47e move coding-conventions.md to guide
The coding-conventions document covers useful introductory guidance for
all.  This commit moves it out of the devel/ detail directory and into the
contributor/guide, fixing up links from other doc's in this repo and
leaving a cookie crumb of a document pointing at the new location.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-01-25 17:29:22 -08:00
k8s-ci-robot 109f173893
Merge pull request #1657 from tpepper/contrib_guide
contrib guide: tighten some language
2018-01-25 00:21:21 -08:00
g-harel 8a6ff19295 added missing link in github-workflow 2018-01-24 15:18:56 -05:00
Tim Pepper 53f3badbe8 contrib guide: tighten some language
The difference between the two links for communications around questions
and troubleshooting was not clear to me, and the wording made them
seem somewhat redundant.  They're really two separate topic links,
so I've changed the wording to hopefully make it more clear that one has
general communications information and once is actually a
troubleshooting guide.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2018-01-24 11:56:01 -08:00
Jorge O. Castro bf0fcc7c5d Fix broken url 2018-01-23 13:20:49 -05:00
Jorge O. Castro 6d51ca785d Remove duplicate content and fix links 2018-01-23 09:13:57 -05:00
Jorge O. Castro 774750b5d2 Moving and revising community expectations 2018-01-22 10:34:16 -05:00
Jorge O. Castro 963c5c51f6 * Remove the working comments from the top so users can just get to the
content
* Remove inline todos and replace with link to labelled issues
2018-01-19 14:47:27 -05:00
guineveresaenger 888adea419 adding contributor cheatsheet link 2018-01-16 13:36:19 -08:00
guineveresaenger dca7f85058 removed unnecessary link from guide README, also removed duplicate text from linked file 2018-01-16 13:33:18 -08:00
guineveresaenger b1f49b18d7 moved cheatsheet to contributor guide for later use 2018-01-12 14:23:59 -08:00
Jessica Yao e21d5d1908 fix broken links 2018-01-10 16:38:23 -08:00
Kai Chen 65a6d2923a Fix incorrect anchor for github markdown header in contributors guide 2018-01-03 16:37:33 -08:00
Kai Chen adb2be5558 Fix broken links in github-workflow.md 2018-01-03 13:21:34 -08:00
guineveresaenger 03e692358d fixing broken link 2018-01-03 12:13:40 -08:00
guineveresaenger 73abfab99d moved Github workflow and diagram to contributors/guide folder and referenced from both development.md and guide README 2018-01-02 14:14:06 -08:00
Christoph Blecker f2816c8bab
Fix some more links 2017-12-22 14:03:56 -08:00
Christoph Blecker ce3044d912
Update references to help wanted label 2017-12-21 17:38:23 -08:00
Tim Pepper 2cdc64a84c contrib guide: update "help wanted" issue url
The doc's referring to "help-wanted" labeled issues, but that shows zero
open and closed, where there's a bunch with "help wanted" through the
project history.  This patch updates the url to search issues with the
"help wanted label.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2017-12-16 07:42:55 -08:00
Tim Pepper 62be7e1aae contrib guide: add table of contents
We're to a point were seeing the table of contents at the top is
informative about overall flow of the doc.  Will need to regenerate this
if/when new sections are added since it's not a render-time artifact.

Relates to issues #1413.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2017-12-14 11:53:44 -08:00
guineveresaenger faf120e3b5 moved warning on where to ask questions to the top 2017-12-14 11:10:37 -08:00
guineveresaenger c1ecc0fbc9 removed comment 2017-12-14 10:56:43 -08:00
guineveresaenger 0ffd43236f clarifying SIG and asking questions 2017-12-14 10:52:28 -08:00
guineveresaenger 55c4f16c91 clarify help wanted issues on each subrepo 2017-12-13 18:00:42 -08:00
guineveresaenger 44bcfd0387 clarify issues vs questions, fix serverfault link 2017-12-13 17:56:46 -08:00
guineveresaenger 159db82c7f explained how to choose a SIG and why 2017-12-13 17:34:26 -08:00
Tim Pepper dd6249f94d contrib guide: add PR, code review sections and cleanup
This patch hits a couple of improvement needed areas:
* add a pull requests section
* add a code review section
* misc smaller cleanups noticed while doing the prior two

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2017-12-13 16:33:23 -08:00
Sahdev P. Zala c3debce3e4 Complete File an Issue section
The File an Issue section is work in progress. Adding more detail with a broader
coverage on what, why and where to file a issue to complete this section.
2017-12-13 15:50:47 -05:00
Sahdev P. Zala f84309aa51 Complete File an Issue section
The File an Issue section is work in progress. Adding more detail with a broader
coverage on what, why and where to file a issue to complete this section.
2017-12-13 15:22:36 -05:00
Tim Pepper 951c10e5d1 contributing guide: add initial section on testing
This commit replaces the "Improvements needed" marker for the testing
topic with an initial section of overview information and jumping off links
to sig-testing, test documentation, and test code.

Part of: https://github.com/kubernetes/community/issues/1413

Signed-off-by: Tim Pepper <tpepper@vmware.com>
2017-12-06 19:27:36 -08:00
Sahdev P. Zala 56be933e98 Add issue triage section
Issue triaging is an important contribution to the project and should be
highlighted with other areas of contribution. Creating this PR per discussion
in the ContribX SIG meeting on November 29, 2017.
2017-11-29 13:32:57 -05:00
Penghao Cen cdcc3d9445 Minor fix typos 2017-11-21 20:30:46 +08:00
guineveresaenger 6adfb9ea5b final redirects 2017-11-20 09:10:09 -08:00
guineveresaenger 05c21e2f27 redirect links and formatting 2017-11-20 09:01:42 -08:00
guineveresaenger c2006e2018 updating KubeCon information 2017-11-16 15:00:01 -08:00
guineveresaenger af68a7a0aa last tweaks 2017-11-16 09:46:26 -08:00
guineveresaenger 6d24d0df04 tweaking 2017-11-16 09:37:43 -08:00
guineveresaenger 6919ee9fc3 entire document edited for real 2017-11-16 09:01:17 -08:00
guineveresaenger bc379f5f9d entire document edited 2017-11-16 09:00:51 -08:00
guineveresaenger a280901642 keep on editing 2017-11-16 08:38:13 -08:00
guineveresaenger 94a7b4cfe6 further cleanup 2017-11-15 16:07:45 -08:00
guineveresaenger 1e58e3f2a0 created /guide folder, and first draft of README for it, with some streamlined tasks 2017-11-15 15:28:42 -08:00