mirror of https://github.com/knative/docs.git
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
Knative Prow Robot
parent
9f8fe54d31
commit
8415851da7
|
|
@ -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)
|
||||
before creating an issue to avoid making a duplicate.
|
||||
2. Use the
|
||||
[correct template](https://github.com/knative/docs/issues/new) for your new
|
||||
issue. There are two templates available:
|
||||
* **Bug report**:
|
||||
If you're reporting an error in the existing documentation, use this
|
||||
template. This could be anything from broken samples to typos. When you
|
||||
create a bug report, include as many details as possible and include
|
||||
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).
|
||||
* **Feature request**:
|
||||
For upcoming changes to the documentation or requests for more
|
||||
information on a particular subject.
|
||||
2. Use the [correct template](https://github.com/knative/docs/issues/new) for
|
||||
your new issue. There are two templates available:
|
||||
- **Bug report**: If you're reporting an error in the existing documentation,
|
||||
use this template. This could be anything from broken samples to typos.
|
||||
When you create a bug report, include as many details as possible and
|
||||
include 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).
|
||||
- **Feature request**: For upcoming changes to the documentation or requests
|
||||
for more information on a particular subject.
|
||||
|
||||
Note that code issues should be filed against the
|
||||
[individual Knative repositories](http://github.com/knative),
|
||||
while documentation issues should go in the `docs` repository.
|
||||
[individual Knative repositories](http://github.com/knative), while
|
||||
documentation issues should go in the `docs` repository.
|
||||
|
||||
## Contributing to the documentation
|
||||
|
||||
### Working group
|
||||
|
||||
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation) meets weekly on
|
||||
Tuesdays and alternates between a 9am PT and a 4:30pm PT time to accommodate
|
||||
contributors in both the EMEA and APAC timezones. [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com)
|
||||
to see the exact dates on the Knative working group calendar. If you're interested
|
||||
in becoming more involved in Knative's documentation, start attending the working
|
||||
group meetings. You'll meet the writers currently steering our documentation
|
||||
efforts, who are happy to help you get started.
|
||||
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation)
|
||||
meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to
|
||||
accommodate contributors in both the EMEA and APAC timezones.
|
||||
[Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com)
|
||||
to see the exact dates on the Knative working group calendar. If you're
|
||||
interested in becoming more involved in Knative's documentation, start attending
|
||||
the working group meetings. You'll meet the writers currently steering our
|
||||
documentation efforts, who are happy to help you get started.
|
||||
|
||||
### Getting started
|
||||
|
||||
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).
|
||||
* Run through the [install guide](../install/README.md) for the platform of your
|
||||
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.
|
||||
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?
|
||||
- Look at issues in the Docs repo labled
|
||||
[Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue).
|
||||
- Run through the [install guide](../install/README.md) for the platform of your
|
||||
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. 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
|
||||
|
||||
|
|
@ -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
|
||||
documentation review as soon as possible.
|
||||
1. If the PR involves significant changes or additions to sample code,
|
||||
we'll flag it for engineer review.
|
||||
1. If the PR involves significant changes or additions to sample code, we'll
|
||||
flag it for engineer review.
|
||||
1. Once we're satisfied with the quality of the writing and the accuracy of the
|
||||
content, we'll approve the change.
|
||||
|
||||
If you're making a change to the documentation, you should submit a PR
|
||||
against the master branch.
|
||||
If you're making a change to the documentation, you should submit a PR against
|
||||
the master branch.
|
||||
|
||||
### Putting your docs in the right place
|
||||
|
||||
Knative uses the [docs repository](https://github.com/knative/docs) for all
|
||||
general documentation for Knative components. However, formal specifications or
|
||||
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 [spec](https://github.com/knative/serving/tree/master/docs/spec) folder
|
||||
in the Serving component.
|
||||
the `docs` folder in a given component's repository. An example of this is the
|
||||
[spec](https://github.com/knative/serving/tree/master/docs/spec) folder in the
|
||||
Serving component.
|
||||
|
||||
Code samples follow a similar strategy, where most code samples should be
|
||||
located in the `docs` repository. If there are code samples used for
|
||||
testing that are only expected to be used by contributors, those samples are put
|
||||
in the `samples` folder within the component repo.
|
||||
located in the `docs` repository. If there are code samples used for testing
|
||||
that are only expected to be used by contributors, those samples are put in the
|
||||
`samples` folder within the component repo.
|
||||
|
|
|
|||
|
|
@ -40,7 +40,9 @@ The current working groups are:
|
|||
|
||||
## 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).
|
||||
|
||||
| Artifact | Link |
|
||||
|
|
@ -79,14 +81,14 @@ API [resources](https://github.com/knative/serving/tree/master/pkg/apis/serving)
|
|||
Knative documentation, especially the [Docs](https://github.com/knative/docs)
|
||||
repo.
|
||||
|
||||
| Artifact | Link |
|
||||
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 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# |
|
||||
| Artifact | Link |
|
||||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 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 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) |
|
||||
| Meeting Notes | [Notes](https://docs.google.com/document/d/1Y7rug0XshcQPdKzptdWbQLQjcjgpFdLeEgP1nfkDAe4/edit) |
|
||||
| Document Folder | [Folder](https://drive.google.com/corp/drive/folders/1K5cM9m-b93ySI5WGKalJKbBq_cfjyi-y) |
|
||||
| Slack Channel | [#docs](https://knative.slack.com/messages/docs) |
|
||||
| Meeting Notes | [Notes](https://docs.google.com/document/d/1Y7rug0XshcQPdKzptdWbQLQjcjgpFdLeEgP1nfkDAe4/edit) |
|
||||
| Document Folder | [Folder](https://drive.google.com/corp/drive/folders/1K5cM9m-b93ySI5WGKalJKbBq_cfjyi-y) |
|
||||
| Slack Channel | [#docs](https://knative.slack.com/messages/docs) |
|
||||
|
||||
| | Leads | Company | Profile |
|
||||
| -------------------------------------------------------- | ---------- | ------- | --------------------------------------- |
|
||||
|
|
|
|||
Loading…
Reference in New Issue