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>
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.
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.
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>
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>
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>
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>
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>
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>
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.
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.
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>
Tim Pepper
Vijay Mateti
Christoph Blecker
Ellen Körbes
Jorge O. Castro
guineveresaenger
k8s-ci-robot
zhuyan
Moshe Immerman
Jessica Yao
Kai Chen
Sahdev P. Zala