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

Run prettier after #123 (#124) 

* Remove WORKING-GROUPS.md link to remove duplicate headings from website.

* prettier --prose-wrap=always --write
This commit is contained in:
Evan Anderson 2020-04-22 07:08:40 -07:00 committed by GitHub
parent 74e2589a6b
commit 0092aa676f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 81 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.md
View File

@ -28,8 +28,8 @@ given the same level of review.
## Working groups
The Knative contributors community is organized into a set of
[working groups](./working-groups/WORKING-GROUPS.md). Any contribution to Knative should be
started by first engaging with the appropriate working group.
[working groups](./working-groups/WORKING-GROUPS.md). Any contribution to
Knative should be started by first engaging with the appropriate working group.
## Code of conduct
@ -53,17 +53,18 @@ necessary because you own the copyright to your changes, even after your
contribution becomes part of this project. So this agreement simply gives us
permission to use and redistribute your contributions as part of the project.
Note: Your contributions are verified using the email address for which you
use to sign the CLA. Therefore,
Note: Your contributions are verified using the email address for which you use
to sign the CLA. Therefore,
[setting your GitHub account to private](https://help.github.com/en/articles/setting-your-commit-email-address)
is unsupported because all commits from private accounts are sent from the `noreply`
email address.
is unsupported because all commits from private accounts are sent from the
`noreply` email address.
## Design documents
Any substantial design deserves a design document ([template](https://docs.google.com/document/d/1s6IIU98bi5FlRNmmBaLAn1rgoleK_ovcL746L7NHq0c/edit)). Design documents are written
with Google Docs and should be shared with the community by adding the doc to
our
Any substantial design deserves a design document
([template](https://docs.google.com/document/d/1s6IIU98bi5FlRNmmBaLAn1rgoleK_ovcL746L7NHq0c/edit)).
Design documents are written with Google Docs and should be shared with the
community by adding the doc to our
[Team Drive](https://drive.google.com/corp/drive/folders/0APnJ_hRs30R2Uk9PVA)
and sending an email to the appropriate working group's mailing list to let
people know the doc is there. To get write access to the drive, you'll need to
@ -84,12 +85,14 @@ later join knative-dev if you want immediate access).
## Contributing documentation
For more information about contributing to the Knative documentation, see
[DOCS-CONTRIBUTING.md](./docs/DOCS-CONTRIBUTING.md). A lot of the information on this
page still applies, but you'll find the specifics about the docs process there.
[DOCS-CONTRIBUTING.md](./docs/DOCS-CONTRIBUTING.md). A lot of the information on
this page still applies, but you'll find the specifics about the docs process
there.
## Contributing a feature
The process for adding features to Knative can be found [here](./mechanics/FEATURE-TRACKS.md).
The process for adding features to Knative can be found
[here](./mechanics/FEATURE-TRACKS.md).
## Setting up to contribute to Knative

29
README.md
View File

@ -25,9 +25,10 @@ Other Documents
- [Values](./VALUES.md) - shared goals and values for the community
- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on
becoming a contributor
- [Working Groups](./working-groups/WORKING-GROUPS.md) - describes our various working groups
- [Working Group Processes](./mechanics/WORKING-GROUP-PROCESSES.md) - describes how
working groups operate
- [Working Groups](./working-groups/WORKING-GROUPS.md) - describes our various
working groups
- [Working Group Processes](./mechanics/WORKING-GROUP-PROCESSES.md) - describes
how working groups operate
- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering
committee
- [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE.md) - describes our
@ -41,9 +42,10 @@ Other Documents
## Introduction
Knative is a Kubernetes-based platform to deploy and manage modern
serverless workloads. See the [Knative documentation](https://github.com/knative/docs/tree/master/docs/README.md) for in-depth
information about using Knative.
Knative is a Kubernetes-based platform to deploy and manage modern serverless
workloads. See the
[Knative documentation](https://github.com/knative/docs/tree/master/docs/README.md)
for in-depth information about using Knative.
## Knative authors
@ -59,23 +61,24 @@ tools, platforms, languages, and products. By submitting a tutorial you can
share your experience and help others who are solving similar problems.
Community tutorials are stored in Markdown files under the `community` folder
[Community Samples](https://github.com/knative/docs/tree/master/community/samples/README.md). These documents are
contributed, reviewed, and maintained by the community.
[Community Samples](https://github.com/knative/docs/tree/master/community/samples/README.md).
These documents are contributed, reviewed, and maintained by the community.
Submit a Pull Request to the community sample directory under the Knative
component folder that aligns with your document. For example, Knative Serving
samples are under the `serving` folder. A reviewer will be assigned to review
your submission. They'll work with you to ensure that your submission is clear,
correct, and meets the [style guide](./docs/DOCS-CONTRIBUTING.md), but it helps if
you follow it as you write your tutorial.
correct, and meets the [style guide](./docs/DOCS-CONTRIBUTING.md), but it helps
if you follow it as you write your tutorial.
## Meetings and work groups
Knative has public and recorded bi-weekly community meetings.
Each project has one or more [working groups](./working-groups/WORKING-GROUPS.md) driving the
project, and Knative as a single
[technical oversight community](./TECH-OVERSIGHT-COMMITTEE.md) monitoring the
Each project has one or more
[working groups](./working-groups/WORKING-GROUPS.md) driving the project, and
Knative has a single
[technical oversight committee](./TECH-OVERSIGHT-COMMITTEE.md) monitoring the
overall project.
## How can I help

4
SLACK-GUIDELINES.md
View File

@ -59,8 +59,8 @@ a member of the [KSC](STEERING-COMMITTEE.md) or
Please reach out to the #slack-admins group with your request to create a new
channel.
Channels are dedicated to [Working Groups](./working-groups/WORKING-GROUPS.md), sub-projects,
community topics, and related programs/projects.
Channels are dedicated to [Working Groups](./working-groups/WORKING-GROUPS.md),
sub-projects, community topics, and related programs/projects.
Channels are not:

32
STEERING-COMMITTEE.md
View File

@ -67,9 +67,10 @@ between members, security reports, etc.) meetings are held in private.
Meeting notes are available to members of the knative-dev mailing list (link to
be added).
Questions and proposals for changes to governance are posted as
[issues in the docs repo](https://github.com/knative/docs/issues), and the KSC invites your feedback
there. See [Getting in touch](#getting-in-touch) for other options.
Questions and proposals for changes to governance are posted as
[issues in the docs repo](https://github.com/knative/docs/issues), and the KSC
invites your feedback there. See [Getting in touch](#getting-in-touch) for other
options.
## Committee members
@ -85,17 +86,18 @@ the KSC will, from time to time, consider if this policy should be changed.
The current membership of the committee is currently (listed alphabetically by
first name):
|   | Member | Organization | Profile |
| ---------------------------------------------------------- | ---------------- | ------------ | -------------------------------------------- |
| <img width="30px" src="https://github.com/bsnchan.png"> | Brenda Chan | VMware | [@bsnchan](https://github.com/bsnchan) |
| <img width="30px" src="https://github.com/mbehrendt.png"> | Michael Behrendt | IBM | [@mbehrendt](https://github.com/mbehrendt) |
| <img width="30px" src="https://github.com/pmorie.png"> | Paul Morie | Red Hat | [@pmorie](https://github.com/pmorie) |
| <img width="30px" src="https://github.com/rgregg.png"> | Ryan Gregg | Google | [@rgregg](https://github.com/rgregg) |
| <img width="30px" src="https://github.com/isdal.png"> | Tomas Isdal | Google | [@isdal](https://github.com/isdal) |
| | Open * | Google | |
| | Open * | Google | |
| &nbsp; | Member | Organization | Profile |
| --------------------------------------------------------- | ---------------- | ------------ | ------------------------------------------ |
| <img width="30px" src="https://github.com/bsnchan.png"> | Brenda Chan | VMware | [@bsnchan](https://github.com/bsnchan) |
| <img width="30px" src="https://github.com/mbehrendt.png"> | Michael Behrendt | IBM | [@mbehrendt](https://github.com/mbehrendt) |
| <img width="30px" src="https://github.com/pmorie.png"> | Paul Morie | Red Hat | [@pmorie](https://github.com/pmorie) |
| <img width="30px" src="https://github.com/rgregg.png"> | Ryan Gregg | Google | [@rgregg](https://github.com/rgregg) |
| <img width="30px" src="https://github.com/isdal.png"> | Tomas Isdal | Google | [@isdal](https://github.com/isdal) |
| | Open \* | Google | |
| | Open \* | Google | |
* Open seats have been allocated to the organization per the committee rules, but have not been assigned to a member of the organization.
- Open seats have been allocated to the organization per the committee rules,
but have not been assigned to a member of the organization.
### Allocation of seats
@ -156,8 +158,8 @@ There are two ways to raise issues to the steering committee for decision:
[knative-steering@googlegroups.com](mailto:knative-steering@googlegroups.com).
This is a private discussion list to which all members of the committee have
access.
2. Open an issue on a knative repository and indicate that you would like attention
from the steering committee.
2. Open an issue on a knative repository and indicate that you would like
attention from the steering committee.
---

26
docs/DOCS-CONTRIBUTING.md
View File

@ -36,11 +36,11 @@ necessary because you own the copyright to your changes, even after your
contribution becomes part of this project. So this agreement simply gives us
permission to use and redistribute your contributions as part of the project.
Note: Your contributions are verified using the email address for which you
use to sign the CLA. Therefore,
Note: Your contributions are verified using the email address for which you use
to sign the CLA. Therefore,
[setting your GitHub account to private](https://help.github.com/en/articles/setting-your-commit-email-address)
is unsupported because all commits from private accounts are sent from the `noreply`
email address.
is unsupported because all commits from private accounts are sent from the
`noreply` email address.
### Style guide
@ -95,7 +95,8 @@ There are a couple different ways to jump in to the Knative doc set:
in the backlog.
- Try out Knative and send us feedback. For example, run through one of the
[install guides](https://github.com/knative/docs/tree/master/docs/install/README.md) and then try
[install guides](https://github.com/knative/docs/tree/master/docs/install/README.md)
and then try
[Getting Started with Knative Serving](https://github.com/knative/docs/tree/master/docs/install/getting-started-knative-app.md).
You should keep a
@ -265,18 +266,18 @@ in the product, or for a fix or update existing content.
1. Add one or more `cherrypick-#.#` labels to that PR to indicate which of
the past release branches should also be fixed. Generally, we only
maintain the most recent numbered release.
1. If you want to complete the fix yourself (**best practice**), you then open a
subsequent PR by running `git cherry-pick [COMMIT#]` against the
`release-0.5`.
Where `[COMMIT#]` is the commit of the PR that you merged in `master`.
1. If you want to complete the fix yourself (**best practice**), you then
open a subsequent PR by running `git cherry-pick [COMMIT#]` against the
`release-0.5`. Where `[COMMIT#]` is the commit of the PR that you merged
in `master`.
Note: Depending on workload and available bandwidth, one of the Knative
team members might be able to help handle the `git cherry-pick` in order
to push the fix into the affected release branch(es).
See a list of the available documentaion versions in the
[branches page](https://github.com/knative/docs/branches)
of the `knative/docs` repo.
[branches page](https://github.com/knative/docs/branches) of the `knative/docs`
repo.
## Assigning owners and reviewers
@ -415,4 +416,5 @@ to become an approver at a meeting of the Documentation Working Group.
Once you feel you meet the criteria, you can ask one of the current approvers to
nominate you to become an approver. If all existing approvers agree that you
meet the criteria open a PR to add yourself as a docs-approver in the
[OWNERS_ALIASES](https://github.com/knative/docs/tree/master/OWNERS_ALIASES) file.
[OWNERS_ALIASES](https://github.com/knative/docs/tree/master/OWNERS_ALIASES)
file.

19
docs/README.md
View File

@ -1,14 +1,21 @@
We're excited that you're interested in contributing to the Knative documentation! Check out the resources below to get started.
We're excited that you're interested in contributing to the Knative
documentation! Check out the resources below to get started.
## Getting started
- [How to contribute](./DOCS-CONTRIBUTING.md) -- Contains information about how to contribute and outlines the roles for Docs contributors.
- [How to contribute](./DOCS-CONTRIBUTING.md) -- Contains information about how
to contribute and outlines the roles for Docs contributors.
- [Template page](https://raw.githubusercontent.com/knative/community/master/docs/new-page-template.md) -- A blank documentation page that demonstrates how to format a new page and includes tips on structuring your documentation.
- [Template page](https://raw.githubusercontent.com/knative/community/master/docs/new-page-template.md)
-- A blank documentation page that demonstrates how to format a new page and
includes tips on structuring your documentation.
## Getting help
- [#docs on the Knative Slack](https://slack.knative.dev) -- The #docs channel is the best place to go if you have questions about making changes to the documentation. We're happy to help!
- [#docs on the Knative Slack](https://slack.knative.dev) -- The #docs channel
is the best place to go if you have questions about making changes to the
documentation. We're happy to help!
- [Documentation working group](../working-groups/WORKING-GROUPS.md#documentation) -- Come join us in the working group to meet other docs contributors and ask any questions you might have.
- [Documentation working group](../working-groups/WORKING-GROUPS.md#documentation)
-- Come join us in the working group to meet other docs contributors and ask
any questions you might have.

7
mechanics/WORKING-GROUP-PROCESSES.md
View File

@ -102,9 +102,10 @@ working group:
these meetings between 9:00AM to 2:59PM Pacific Time. Invite the public Google
group to the meeting.
- **Register the Working Group**. Go to [WORKING-GROUPS.md](../working-groups/WORKING-GROUPS.md)
and add your working group name, the names of the leads, the working group
charter, and a link to the meeting you created.
- **Register the Working Group**. Go to
[WORKING-GROUPS.md](../working-groups/WORKING-GROUPS.md) and add your working
group name, the names of the leads, the working group charter, and a link to
the meeting you created.
- **Announce your Working Group**. Send a note to
[knative-dev@](mailto:knative-dev@googlegroups.com) and