Commit Graph

127 Commits

Author SHA1 Message Date
ignertic 08fd17f08b
Add Meet Our Contributors link 2018-10-29 12:04:15 +02:00
Arnaud Meukam 46ded5d187 add the redirection for the good first issues 2018-09-27 03:15:51 +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
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
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
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
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
Carolyn Van Slyck 742a0445d6
Define good first issue and clarify help wanted labels 2018-06-09 17:21:55 -05: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
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
Vijay Mateti eebd98b8ef
Fix for duplicate title on Contributors guide README 2018-04-09 11:17:02 -04: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
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
Jorge O. Castro 40863e00d0 Add mention of membership roles to contrib guide 2018-02-22 15:19:36 -05: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
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
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
zhuyan 06b3a38988 doc: fix typo in contributors guideline. 2018-01-30 05:32:22 +08:00
Moshe Immerman 303a0a8185
fix: broken link to community-expectations.md 2018-01-28 12:33:45 +02: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
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
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 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
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
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