Skip to content

Commit 01d4ba3

Browse files
mattmoor-sockpuppetknative-prow-robot
mattmoor-sockpuppet
authored and
knative-prow-robot
committed
Format markdown (knative#1070)
* Format markdown Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)` * Apply suggestions from code review Co-Authored-By: mattmoor-sockpuppet <[email protected]> * Undo parts of auto-correction that result in diff.
1 parent 9910b8a commit 01d4ba3

File tree

85 files changed

+847
-802
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+847
-802
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ docs and learn about Knative.
77

88
## Source files
99

10-
View the source files if you want to contribute a fix or add new content.
11-
Each release of the Knative docs are
10+
View the source files if you want to contribute a fix or add new content. Each
11+
release of the Knative docs are
1212
[branched](https://github.com/knative/docs/branches). If you are looking for an
1313
archived doc set, see the list of available versions in
1414
[Knative doc releases](./doc-releases.md).

‎blog/_index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ menu:
77
type: "blog"
88
---
99

10-
1110
Welcome to the Knative **blog** section. Keep up-to-date with product and
12-
release announcements, read articles, hear about recent social events, and
13-
find out where the Knative team will be talking next.
11+
release announcements, read articles, hear about recent social events, and find
12+
out where the Knative team will be talking next.

‎blog/articles/_index.md

-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@ linkTitle: "Articles"
44
weight: 30
55
type: "blog"
66
---
7-

‎community/samples/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Sample apps
22

3-
| Sample Name | Knative Component | Description | Language(s) |
4-
| --------------| ----------------- | -------------------------- | ----------------- |
5-
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
3+
| Sample Name | Knative Component | Description | Language(s) |
4+
| ----------- | ----------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5+
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |

‎community/samples/_index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ type: "docs"
88
Get up and running in a language of your choice using one of the community
99
contributed and maintained sample apps.
1010

11-
Use the following table to view the instructions and sample code in the knative/docs repo.
11+
Use the following table to view the instructions and sample code in the
12+
knative/docs repo.
1213

1314
{{% readfile file="README.md" relative="true" markdown="true" %}}

‎community/samples/serving/helloworld-clojure/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
77
## Prerequisites
88

99
- A Kubernetes cluster with Knative installed. Follow the
10-
[installation instructions](../../../install/README.md)
11-
if you need to create one.
10+
[installation instructions](../../../install/README.md) if you need to create
11+
one.
1212
- [Docker](https://www.docker.com) installed and running on your local machine,
1313
and a Docker Hub account configured (we'll use it for a container registry).
1414

‎community/samples/serving/helloworld-dart/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ that you can use for testing. It reads in the env variable `TARGET` and prints
88
## Prerequisites
99

1010
- A Kubernetes cluster with Knative installed. Follow the
11-
[installation instructions](../../../install/README.md)
12-
if you need to create one.
11+
[installation instructions](../../../install/README.md) if you need to create
12+
one.
1313
- [Docker](https://www.docker.com) installed and running on your local machine,
1414
and a Docker Hub account configured (we'll use it for a container registry).
1515
- [dart-sdk](https://www.dartlang.org/tools/sdk#install) installed and

‎community/samples/serving/helloworld-haskell/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
77
## Prerequisites
88

99
- A Kubernetes cluster with Knative installed. Follow the
10-
[installation instructions](../../../install/README.md)
11-
if you need to create one.
10+
[installation instructions](../../../install/README.md) if you need to create
11+
one.
1212
- [Docker](https://www.docker.com) installed and running on your local machine,
1313
and a Docker Hub account configured (we'll use it for a container registry).
1414

‎community/samples/serving/helloworld-rust/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ TARGET is not specified, it will use "World" as the TARGET.
88
## Prerequisites
99

1010
- A Kubernetes cluster with Knative installed. Follow the
11-
[installation instructions](../../../install/README.md)
12-
if you need to create one.
11+
[installation instructions](../../../install/README.md) if you need to create
12+
one.
1313
- [Docker](https://www.docker.com) installed and running on your local machine,
1414
and a Docker Hub account configured (we'll use it for a container registry).
1515

‎community/samples/serving/helloworld-shell/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ variable is not specified, the script uses `World`.
77
## Prerequisites
88

99
- A Kubernetes cluster with Knative installed. Follow the
10-
[installation instructions](../../../install/README.md)
11-
if you need to create one.
10+
[installation instructions](../../../install/README.md) if you need to create
11+
one.
1212
- [Docker](https://www.docker.com) installed and running on your local machine,
1313
and a Docker Hub account configured (we'll use it for a container registry).
1414

‎community/samples/serving/helloworld-vertx/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ You must meet the following requirements to complete this sample:
1515

1616
- A version of the Knative Serving component installed and running on your
1717
Kubernetes cluster. Follow the
18-
[Knative installation instructions](../../../install/README.md)
19-
if you need to create a Knative cluster.
18+
[Knative installation instructions](../../../install/README.md) if you need to
19+
create a Knative cluster.
2020
- The following software downloaded and install on your loacal machine:
2121
- [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
2222
- [Eclipse Vert.x v3.5.4](https://vertx.io/).

‎contributing/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ page still applies, but you'll find the specifics about the docs process there.
8686
In order to contribute a feature to Knative you'll need to go through the
8787
following steps:
8888

89-
- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md) on
90-
the working group's mailing list.
89+
- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md)
90+
on the working group's mailing list.
9191

9292
- Once there is general agreement that the feature is useful,
9393
[create a GitHub issue](https://github.com/knative/docs/issues/new) to track

‎contributing/DOCS-CONTRIBUTING.md

+48-47
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Note that code issues should be filed against the
5353
[individual Knative repositories](http://github.com/knative), while
5454
documentation issues should go in the `docs` repository.
5555

56-
5756
### Working group
5857

5958
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation)
@@ -112,8 +111,8 @@ that are only expected to be used by contributors, those samples are put in the
112111
## Docs contributor roles
113112

114113
Because contributing to the documentation requires a different skill set than
115-
contributing to the Knative code base, we've defined the roles of
116-
documentation contributors seperately from the roles of code contributors.
114+
contributing to the Knative code base, we've defined the roles of documentation
115+
contributors seperately from the roles of code contributors.
117116

118117
If you're looking for code contributor roles, see [ROLES](./ROLES.md).
119118

@@ -122,21 +121,21 @@ If you're looking for code contributor roles, see [ROLES](./ROLES.md).
122121
Established contributor to the Knative docs.
123122

124123
Members are continuously active contributors in the community. They can have
125-
issues and PRs assigned to them, might participate in working group meetings, and
126-
pre-submit tests are automatically run for their PRs. Members are expected to
127-
remain active contributors to the Knative documentation.
124+
issues and PRs assigned to them, might participate in working group meetings,
125+
and pre-submit tests are automatically run for their PRs. Members are expected
126+
to remain active contributors to the Knative documentation.
128127

129-
All members are encouraged to help with PR reviews, although each PR
130-
must be reviewed by an official [Approver](#approver). In their review,
131-
members should be looking for technical correctness of the documentation,
132-
adherence to the [style guide](https://developers.google.com/style/), good spelling and grammar (writing quality),
133-
intuitive organization, and strong documentation usability. Members should be
134-
proficient in at least one of these review areas.
128+
All members are encouraged to help with PR reviews, although each PR must be
129+
reviewed by an official [Approver](#approver). In their review, members should
130+
be looking for technical correctness of the documentation, adherence to the
131+
[style guide](https://developers.google.com/style/), good spelling and grammar
132+
(writing quality), intuitive organization, and strong documentation usability.
133+
Members should be proficient in at least one of these review areas.
135134

136135
### Requirements
137136

138-
- Has made multiple contributions to the project or community. Contributions might
139-
include, but are not limited to:
137+
- Has made multiple contributions to the project or community. Contributions
138+
might include, but are not limited to:
140139

141140
- Authoring and reviewing PRs on GitHub in the Docs or Website repos.
142141

@@ -157,42 +156,45 @@ proficient in at least one of these review areas.
157156

158157
- Responsive to issues and PRs assigned to them.
159158

160-
- Active owner of documents they have contributed (unless ownership is explicitly
161-
transferred).
162-
159+
- Active owner of documents they have contributed (unless ownership is
160+
explicitly transferred).
161+
163162
- Addresses bugs or issues in their documentation in a timely manner.
164-
163+
165164
### Becoming a member
166165

167-
First, reach out to an approver and ask them to sponsor you so that you can become a member.
168-
The easiest way to do this is using Slack.
166+
First, reach out to an approver and ask them to sponsor you so that you can
167+
become a member. The easiest way to do this is using Slack.
169168

170-
If they are supportive of your membership, your sponsor will reach out to the Knative Steering
171-
committee to ask that you be added as a member of the Knative org.
169+
If they are supportive of your membership, your sponsor will reach out to the
170+
Knative Steering committee to ask that you be added as a member of the Knative
171+
org.
172+
173+
Once your sponsor notifies you that you've been added to the Knative org, open a
174+
PR to add yourself as a docs-reviewer in the [OWNERS_ALIASES](../OWNERS_ALIASES)
175+
file.
172176

173-
Once your sponsor notifies you that you've been added to the Knative org,
174-
open a PR to add yourself as a docs-reviewer in the
175-
[OWNERS_ALIASES](../OWNERS_ALIASES) file.
176-
177177
## Approver
178178

179179
Docs approvers are able to both review and approve documentation contributions.
180180
While documentation review is focused on writing quality and correctness,
181181
approval is focused on holistic acceptance of a contribution including:
182-
long-term maintainability, adhering to style guide conventions, overall information
183-
architecture, and usability from an engineering standpoint. Docs approvers will
184-
enlist help from engineers for reviewing code-heavy contributions to the Docs repo.
182+
long-term maintainability, adhering to style guide conventions, overall
183+
information architecture, and usability from an engineering standpoint. Docs
184+
approvers will enlist help from engineers for reviewing code-heavy contributions
185+
to the Docs repo.
185186

186187
### Requirements
187188

188189
- Reviewer of the Docs repo for at least 3 months.
189-
190-
- Proficient in reviewing all aspects of writing quality, including grammar and
191-
spelling, adherence to style guide conventions, organization, and usability.
192-
Can coach newer writers to improve their contributions in these areas.
193-
194-
- Primary reviewer for at least 10 substantial PRs to the docs, showing substantial
195-
ability to coach for writing development.
190+
191+
- Proficient in reviewing all aspects of writing quality, including grammar
192+
and spelling, adherence to style guide conventions, organization, and
193+
usability. Can coach newer writers to improve their contributions in these
194+
areas.
195+
196+
- Primary reviewer for at least 10 substantial PRs to the docs, showing
197+
substantial ability to coach for writing development.
196198

197199
- Reviewed or merged at least 30 PRs to the docs.
198200

@@ -204,9 +206,9 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
204206

205207
- Responsible for documentation quality control via PR reviews.
206208

207-
- Focus on long-term maintainability, adhering to style
208-
guide conventions, overall information architecture, and usability from
209-
an engineering standpoint.
209+
- Focus on long-term maintainability, adhering to style guide conventions,
210+
overall information architecture, and usability from an engineering
211+
standpoint.
210212

211213
- Expected to be responsive to review requests as per
212214
[community expectations](REVIEWING.md).
@@ -218,12 +220,11 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
218220

219221
### Becoming an approver
220222

221-
If you want to become an approver, make your goal clear to the current
222-
Knative Docs approvers, either by contacting them in Slack or announcing
223-
your intention to become an approver at a meeting of the Documentation
224-
Working Group.
223+
If you want to become an approver, make your goal clear to the current Knative
224+
Docs approvers, either by contacting them in Slack or announcing your intention
225+
to become an approver at a meeting of the Documentation Working Group.
225226

226-
Once you feel you meet the criteria, you can ask one of the current
227-
approvers to nominate you to become an approver. If all existing
228-
approvers agree that you meet the criteria open a PR to add yourself
229-
as a docs-approver in the [OWNERS_ALIASES](../OWNERS_ALIASES) file.
227+
Once you feel you meet the criteria, you can ask one of the current approvers to
228+
nominate you to become an approver. If all existing approvers agree that you
229+
meet the criteria open a PR to add yourself as a docs-approver in the
230+
[OWNERS_ALIASES](../OWNERS_ALIASES) file.

‎contributing/README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
_Important_. Before proceeding, please review the Knative community
32
[Code of Conduct](./CODE-OF-CONDUCT.md).
43

@@ -23,14 +22,15 @@ Other Documents
2322

2423
- [Code of Conduct](./CODE-OF-CONDUCT.md) - all contributors must abide by the
2524
code of conduct
26-
- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on becoming
27-
a contributor
25+
- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on
26+
becoming a contributor
2827
- [Working Groups](./WORKING-GROUPS.md) - describes our various working groups
29-
- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how working
30-
groups operate
28+
- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how
29+
working groups operate
3130
- [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE.md) - describes our
3231
technical oversight committee
33-
- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering committee
32+
- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering
33+
committee
3434
- [Community Roles](./ROLES.md) - describes the roles individuals can assume
3535
within the Knative community
3636
- [Reviewing and Merging Pull Requests](./REVIEWING.md) - how we manage pull
@@ -39,8 +39,8 @@ Other Documents
3939
## Introduction
4040

4141
Knative is a Kubernetes-based platform to build, deploy, and manage modern
42-
serverless workloads. See [Knative docs](../docs/README.md) for
43-
in-depth information about using Knative.
42+
serverless workloads. See [Knative docs](../docs/README.md) for in-depth
43+
information about using Knative.
4444

4545
## Knative authors
4646

@@ -56,15 +56,15 @@ tools, platforms, languages, and products. By submitting a tutorial you can
5656
share your experience and help others who are solving similar problems.
5757

5858
Community tutorials are stored in Markdown files under the `community` folder
59-
[Community Samples](../community/samples/README.md). These documents
60-
are contributed, reviewed, and maintained by the community.
59+
[Community Samples](../community/samples/README.md). These documents are
60+
contributed, reviewed, and maintained by the community.
6161

6262
Submit a Pull Request to the community sample directory under the Knative
6363
component folder that aligns with your document. For example, Knative Serving
64-
samples are under the `serving` folder. A reviewer will be assigned to review your
65-
submission. They'll work with you to ensure that your submission is clear, correct,
66-
and meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if you follow it
67-
as you write your tutorial.
64+
samples are under the `serving` folder. A reviewer will be assigned to review
65+
your submission. They'll work with you to ensure that your submission is clear,
66+
correct, and meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if
67+
you follow it as you write your tutorial.
6868

6969
## Meetings and work groups
7070

@@ -98,7 +98,8 @@ following resources are available for you:
9898
- [Knative Users](https://groups.google.com/forum/#!forum/knative-users)
9999
- [Knative Developers](https://groups.google.com/forum/#!forum/knative-dev)
100100

101-
For contributors to Knative, we also have [Knative Slack](./SLACK-GUIDELINES.md).
101+
For contributors to Knative, we also have
102+
[Knative Slack](./SLACK-GUIDELINES.md).
102103

103104
---
104105

‎contributing/REVIEWING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Please do not ever hesitate to ask a question or submit a PR.
3030

3131
Reviewers are often the first points of contact between new members of the
3232
community and are important in shaping the community. We encourage reviewers to
33-
read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and
34-
beyond the code of conduct to promote a collaborative and respectful community.
33+
read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and beyond the
34+
code of conduct to promote a collaborative and respectful community.
3535

3636
## Code reviewers
3737

0 commit comments

Comments
 (0)