knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Format markdown (#681) 

Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
This commit is contained in:
mattmoor-sockpuppet 2018-12-26 08:11:36 -08:00 committed by Knative Prow Robot
parent 9f8fe54d31
commit 8415851da7
2 changed files with 51 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
community/DOCS-CONTRIBUTING.md
View File

@ -27,46 +27,49 @@ see a problem with the documentation, submit an issue using the following steps:
1. Check the [Knative docs issues list](https://github.com/knative/docs/issues) 1. Check the [Knative docs issues list](https://github.com/knative/docs/issues)
before creating an issue to avoid making a duplicate. before creating an issue to avoid making a duplicate.
2. Use the 2. Use the [correct template](https://github.com/knative/docs/issues/new) for
[correct template](https://github.com/knative/docs/issues/new) for your new your new issue. There are two templates available:
issue. There are two templates available: - **Bug report**: If you're reporting an error in the existing documentation,
* **Bug report**: use this template. This could be anything from broken samples to typos.
If you're reporting an error in the existing documentation, use this When you create a bug report, include as many details as possible and
template. This could be anything from broken samples to typos. When you include suggested fixes to the issue. If you know which Knative component
create a bug report, include as many details as possible and include your bug is related to, you can assign the appropriate
suggested fixes to the issue. If you know which Knative component your
bug is related to, you can assign the appropriate
[Working Group Lead](./WORKING-GROUPS.md). [Working Group Lead](./WORKING-GROUPS.md).
* **Feature request**: - **Feature request**: For upcoming changes to the documentation or requests
For upcoming changes to the documentation or requests for more for more information on a particular subject.
information on a particular subject.
Note that code issues should be filed against the Note that code issues should be filed against the
[individual Knative repositories](http://github.com/knative), [individual Knative repositories](http://github.com/knative), while
while documentation issues should go in the `docs` repository. documentation issues should go in the `docs` repository.
## Contributing to the documentation ## Contributing to the documentation
### Working group ### Working group
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation) meets weekly on The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation)
Tuesdays and alternates between a 9am PT and a 4:30pm PT time to accommodate meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to
contributors in both the EMEA and APAC timezones. [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) accommodate contributors in both the EMEA and APAC timezones.
to see the exact dates on the Knative working group calendar. If you're interested [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com)
in becoming more involved in Knative's documentation, start attending the working to see the exact dates on the Knative working group calendar. If you're
group meetings. You'll meet the writers currently steering our documentation interested in becoming more involved in Knative's documentation, start attending
efforts, who are happy to help you get started. the working group meetings. You'll meet the writers currently steering our
documentation efforts, who are happy to help you get started.
### Getting started ### Getting started
There are a couple different ways to jump in to the Knative doc set: There are a couple different ways to jump in to the Knative doc set:
* Look at issues in the Docs repo labled [Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue). - Look at issues in the Docs repo labled
* Run through the [install guide](../install/README.md) for the platform of your [Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue).
choice, as well as the [Getting Started with Knative App Deployment](../install/getting-started-knative-app.md) guide, and keep a [friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging) of the experience. - Run through the [install guide](../install/README.md) for the platform of your
What was hard for you? Then open a PR with a few improvements you could make choice, as well as the
from the friction log you kept. How can you make the documentation better so [Getting Started with Knative App Deployment](../install/getting-started-knative-app.md)
that others don't run into the same issues you did? guide, and keep a
[friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging)
of the experience. What was hard for you? Then open a PR with a few
improvements you could make from the friction log you kept. How can you make
the documentation better so that others don't run into the same issues you
did?
### Submitting documentation PRs - what to expect ### Submitting documentation PRs - what to expect
@ -74,24 +77,24 @@ Here's what will happen after you open a PR in the Docs repo:
1. One of the Docs approvers will triage the PR and provide an initial 1. One of the Docs approvers will triage the PR and provide an initial
documentation review as soon as possible. documentation review as soon as possible.
1. If the PR involves significant changes or additions to sample code, 1. If the PR involves significant changes or additions to sample code, we'll
we'll flag it for engineer review. flag it for engineer review.
1. Once we're satisfied with the quality of the writing and the accuracy of the 1. Once we're satisfied with the quality of the writing and the accuracy of the
content, we'll approve the change. content, we'll approve the change.
If you're making a change to the documentation, you should submit a PR If you're making a change to the documentation, you should submit a PR against
against the master branch. the master branch.
### Putting your docs in the right place ### Putting your docs in the right place
Knative uses the [docs repository](https://github.com/knative/docs) for all Knative uses the [docs repository](https://github.com/knative/docs) for all
general documentation for Knative components. However, formal specifications or general documentation for Knative components. However, formal specifications or
documentation most relevant to contributors of a component should be placed in documentation most relevant to contributors of a component should be placed in
the `docs` folder in a given component's repository. An example of this is the `docs` folder in a given component's repository. An example of this is the
the [spec](https://github.com/knative/serving/tree/master/docs/spec) folder [spec](https://github.com/knative/serving/tree/master/docs/spec) folder in the
in the Serving component. Serving component.
Code samples follow a similar strategy, where most code samples should be Code samples follow a similar strategy, where most code samples should be
located in the `docs` repository. If there are code samples used for located in the `docs` repository. If there are code samples used for testing
testing that are only expected to be used by contributors, those samples are put that are only expected to be used by contributors, those samples are put in the
in the `samples` folder within the component repo. `samples` folder within the component repo.

6
community/WORKING-GROUPS.md
View File

@ -40,7 +40,9 @@ The current working groups are:
## API Core ## API Core
API [resources](https://github.com/knative/serving/tree/master/pkg/apis/serving), [validation](https://github.com/knative/pkg/tree/master/webhook), and API
[resources](https://github.com/knative/serving/tree/master/pkg/apis/serving),
[validation](https://github.com/knative/pkg/tree/master/webhook), and
[semantics](https://github.com/knative/pkg/tree/master/controller). [semantics](https://github.com/knative/pkg/tree/master/controller).
| Artifact | Link | | Artifact | Link |
@ -80,7 +82,7 @@ Knative documentation, especially the [Docs](https://github.com/knative/docs)
repo. repo.
| Artifact | Link | | Artifact | Link |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Forum | [knative-docs@](https://groups.google.com/forum/#!forum/knative-docs) | | Forum | [knative-docs@](https://groups.google.com/forum/#!forum/knative-docs) |
| Community Meeting VC | [meet.google.com/mku-npuv-cjs](https://meet.google.com/mku-npuv-cjs) <br>Or dial in:<br>(US) +1 260-277-0211<br>PIN: 956 724#‬‬ | | Community Meeting VC | [meet.google.com/mku-npuv-cjs](https://meet.google.com/mku-npuv-cjs) <br>Or dial in:<br>(US) +1 260-277-0211<br>PIN: 956 724#‬‬ |
| Community Meeting Calendar | Weekly on Tuesdays, alternating between 9:00-9:30am and 4:30-5:00pm PST<br>[Calendar](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) | | Community Meeting Calendar | Weekly on Tuesdays, alternating between 9:00-9:30am and 4:30-5:00pm PST<br>[Calendar](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) |