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.
norman465 · Mar 25, 2019 · 01d4ba3 · 01d4ba3
1 parent 9910b8a
commit 01d4ba3
Show file tree

Hide file tree

Showing 85 changed files with 847 additions and 802 deletions.
diff --git a/README.md b/README.md
@@ -7,8 +7,8 @@ docs and learn about Knative.
 
 ## Source files
 
-View the source files if you want to contribute a fix or add new content.
-Each release of the Knative docs are
+View the source files if you want to contribute a fix or add new content. Each
+release of the Knative docs are
 [branched](https://github.com/knative/docs/branches). If you are looking for an
 archived doc set, see the list of available versions in
 [Knative doc releases](./doc-releases.md).
diff --git a/blog/_index.md b/blog/_index.md
@@ -7,7 +7,6 @@ menu:
 type: "blog"
 ---
 
-
 Welcome to the Knative **blog** section. Keep up-to-date with product and
-release announcements, read articles,  hear about recent social events, and
-find out where the Knative team will be talking next.
+release announcements, read articles, hear about recent social events, and find
+out where the Knative team will be talking next.
diff --git a/blog/articles/_index.md b/blog/articles/_index.md
@@ -4,4 +4,3 @@ linkTitle: "Articles"
 weight: 30
 type: "blog"
 ---
-
diff --git a/community/samples/README.md b/community/samples/README.md
@@ -1,5 +1,5 @@
 ## Sample apps
 
-| Sample Name   | Knative Component | Description                | Language(s)       |
-| --------------| ----------------- | -------------------------- | ----------------- |
-| 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) |
+| Sample Name | Knative Component | Description                                                | Language(s)                                                                                                                                                                                                                                                                                                                                                                                  |
+| ----------- | ----------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 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) |
diff --git a/community/samples/_index.md b/community/samples/_index.md
@@ -8,6 +8,7 @@ type: "docs"
 Get up and running in a language of your choice using one of the community
 contributed and maintained sample apps.
 
-Use the following table to view the instructions and sample code in the knative/docs repo.
+Use the following table to view the instructions and sample code in the
+knative/docs repo.
 
 {{% readfile file="README.md" relative="true" markdown="true" %}}
diff --git a/community/samples/serving/helloworld-clojure/README.md b/community/samples/serving/helloworld-clojure/README.md
@@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
 ## Prerequisites
 
 - A Kubernetes cluster with Knative installed. Follow the
-  [installation instructions](../../../install/README.md)
-  if you need to create one.
+  [installation instructions](../../../install/README.md) if you need to create
+  one.
 - [Docker](https://www.docker.com) installed and running on your local machine,
   and a Docker Hub account configured (we'll use it for a container registry).
 

diff --git a/community/samples/serving/helloworld-dart/README.md b/community/samples/serving/helloworld-dart/README.md
@@ -8,8 +8,8 @@ that you can use for testing. It reads in the env variable `TARGET` and prints
 ## Prerequisites
 
 - A Kubernetes cluster with Knative installed. Follow the
-  [installation instructions](../../../install/README.md)
-  if you need to create one.
+  [installation instructions](../../../install/README.md) if you need to create
+  one.
 - [Docker](https://www.docker.com) installed and running on your local machine,
   and a Docker Hub account configured (we'll use it for a container registry).
 - [dart-sdk](https://www.dartlang.org/tools/sdk#install) installed and

diff --git a/community/samples/serving/helloworld-haskell/README.md b/community/samples/serving/helloworld-haskell/README.md
@@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
 ## Prerequisites
 
 - A Kubernetes cluster with Knative installed. Follow the
-  [installation instructions](../../../install/README.md)
-  if you need to create one.
+  [installation instructions](../../../install/README.md) if you need to create
+  one.
 - [Docker](https://www.docker.com) installed and running on your local machine,
   and a Docker Hub account configured (we'll use it for a container registry).
 

diff --git a/community/samples/serving/helloworld-rust/README.md b/community/samples/serving/helloworld-rust/README.md
@@ -8,8 +8,8 @@ TARGET is not specified, it will use "World" as the TARGET.
 ## Prerequisites
 
 - A Kubernetes cluster with Knative installed. Follow the
-  [installation instructions](../../../install/README.md)
-  if you need to create one.
+  [installation instructions](../../../install/README.md) if you need to create
+  one.
 - [Docker](https://www.docker.com) installed and running on your local machine,
   and a Docker Hub account configured (we'll use it for a container registry).
 

diff --git a/community/samples/serving/helloworld-shell/README.md b/community/samples/serving/helloworld-shell/README.md
@@ -7,8 +7,8 @@ variable is not specified, the script uses `World`.
 ## Prerequisites
 
 - A Kubernetes cluster with Knative installed. Follow the
-  [installation instructions](../../../install/README.md)
-  if you need to create one.
+  [installation instructions](../../../install/README.md) if you need to create
+  one.
 - [Docker](https://www.docker.com) installed and running on your local machine,
   and a Docker Hub account configured (we'll use it for a container registry).
 

diff --git a/community/samples/serving/helloworld-vertx/README.md b/community/samples/serving/helloworld-vertx/README.md
@@ -15,8 +15,8 @@ You must meet the following requirements to complete this sample:
 
 - A version of the Knative Serving component installed and running on your
   Kubernetes cluster. Follow the
-  [Knative installation instructions](../../../install/README.md)
-  if you need to create a Knative cluster.
+  [Knative installation instructions](../../../install/README.md) if you need to
+  create a Knative cluster.
 - The following software downloaded and install on your loacal machine:
   - [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
   - [Eclipse Vert.x v3.5.4](https://vertx.io/).

diff --git a/contributing/CONTRIBUTING.md b/contributing/CONTRIBUTING.md
@@ -86,8 +86,8 @@ page still applies, but you'll find the specifics about the docs process there.
 In order to contribute a feature to Knative you'll need to go through the
 following steps:
 
-- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md) on
-  the working group's mailing list.
+- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md)
+  on the working group's mailing list.
 
 - Once there is general agreement that the feature is useful,
   [create a GitHub issue](https://github.com/knative/docs/issues/new) to track

diff --git a/contributing/DOCS-CONTRIBUTING.md b/contributing/DOCS-CONTRIBUTING.md
@@ -53,7 +53,6 @@ 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.
 
-
 ### Working group
 
 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
 ## Docs contributor roles
 
 Because contributing to the documentation requires a different skill set than
-contributing to the Knative code base, we've defined the roles of
-documentation contributors seperately from the roles of code contributors.
+contributing to the Knative code base, we've defined the roles of documentation
+contributors seperately from the roles of code contributors.
 
 If you're looking for code contributor roles, see [ROLES](./ROLES.md).
 
@@ -122,21 +121,21 @@ If you're looking for code contributor roles, see [ROLES](./ROLES.md).
 Established contributor to the Knative docs.
 
 Members are continuously active contributors in the community. They can have
-issues and PRs assigned to them, might participate in working group meetings, and
-pre-submit tests are automatically run for their PRs. Members are expected to
-remain active contributors to the Knative documentation.
+issues and PRs assigned to them, might participate in working group meetings,
+and pre-submit tests are automatically run for their PRs. Members are expected
+to remain active contributors to the Knative documentation.
 
-All members are encouraged to help with PR reviews, although each PR
-must be reviewed by an official [Approver](#approver). In their review,
-members should be looking for technical correctness of the documentation,
-adherence to the [style guide](https://developers.google.com/style/), good spelling and grammar (writing quality),
-intuitive organization, and strong documentation usability. Members should be
-proficient in at least one of these review areas.
+All members are encouraged to help with PR reviews, although each PR must be
+reviewed by an official [Approver](#approver). In their review, members should
+be looking for technical correctness of the documentation, adherence to the
+[style guide](https://developers.google.com/style/), good spelling and grammar
+(writing quality), intuitive organization, and strong documentation usability.
+Members should be proficient in at least one of these review areas.
 
 ### Requirements
 
-- Has made multiple contributions to the project or community. Contributions might
-  include, but are not limited to:
+- Has made multiple contributions to the project or community. Contributions
+  might include, but are not limited to:
 
   - Authoring and reviewing PRs on GitHub in the Docs or Website repos.
 
@@ -157,42 +156,45 @@ proficient in at least one of these review areas.
 
 - Responsive to issues and PRs assigned to them.
 
-- Active owner of documents they have contributed (unless ownership is explicitly
-  transferred).
-  
+- Active owner of documents they have contributed (unless ownership is
+  explicitly transferred).
+
   - Addresses bugs or issues in their documentation in a timely manner.
-  
+
 ### Becoming a member
 
-First, reach out to an approver and ask them to sponsor you so that you can become a member.
-The easiest way to do this is using Slack.
+First, reach out to an approver and ask them to sponsor you so that you can
+become a member. The easiest way to do this is using Slack.
 
-If they are supportive of your membership, your sponsor will reach out to the Knative Steering
-committee to ask that you be added as a member of the Knative org. 
+If they are supportive of your membership, your sponsor will reach out to the
+Knative Steering committee to ask that you be added as a member of the Knative
+org.
+
+Once your sponsor notifies you that you've been added to the Knative org, open a
+PR to add yourself as a docs-reviewer in the [OWNERS_ALIASES](../OWNERS_ALIASES)
+file.
 
-Once your sponsor notifies you that you've been added to the Knative org,
-open a PR to add yourself as a docs-reviewer in the
-[OWNERS_ALIASES](../OWNERS_ALIASES) file.
-
 ## Approver
 
 Docs approvers are able to both review and approve documentation contributions.
 While documentation review is focused on writing quality and correctness,
 approval is focused on holistic acceptance of a contribution including:
-long-term maintainability, adhering to style guide conventions, overall information
-architecture, and usability from an engineering standpoint. Docs approvers will
-enlist help from engineers for reviewing code-heavy contributions to the Docs repo.
+long-term maintainability, adhering to style guide conventions, overall
+information architecture, and usability from an engineering standpoint. Docs
+approvers will enlist help from engineers for reviewing code-heavy contributions
+to the Docs repo.
 
 ### Requirements
 
 - Reviewer of the Docs repo for at least 3 months.
-
-  - Proficient in reviewing all aspects of writing quality, including grammar and
-    spelling, adherence to style guide conventions, organization, and usability.
-    Can coach newer writers to improve their contributions in these areas.
-
-- Primary reviewer for at least 10 substantial PRs to the docs, showing substantial
-  ability to coach for writing development.
+
+  - Proficient in reviewing all aspects of writing quality, including grammar
+    and spelling, adherence to style guide conventions, organization, and
+    usability. Can coach newer writers to improve their contributions in these
+    areas.
+
+- Primary reviewer for at least 10 substantial PRs to the docs, showing
+  substantial ability to coach for writing development.
 
 - Reviewed or merged at least 30 PRs to the docs.
 
@@ -204,9 +206,9 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
 
 - Responsible for documentation quality control via PR reviews.
 
-  - Focus on long-term maintainability, adhering to style
-    guide conventions, overall information architecture, and usability from
-    an engineering standpoint.
+  - Focus on long-term maintainability, adhering to style guide conventions,
+    overall information architecture, and usability from an engineering
+    standpoint.
 
 - Expected to be responsive to review requests as per
   [community expectations](REVIEWING.md).
@@ -218,12 +220,11 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
 
 ### Becoming an approver
 
-If you want to become an approver, make your goal clear to the current
-Knative Docs approvers, either by contacting them in Slack or announcing
-your intention to become an approver at a meeting of the Documentation
-Working Group.
+If you want to become an approver, make your goal clear to the current Knative
+Docs approvers, either by contacting them in Slack or announcing your intention
+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](../OWNERS_ALIASES) file.
+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](../OWNERS_ALIASES) file.
diff --git a/contributing/README.md b/contributing/README.md
@@ -1,4 +1,3 @@
-
 _Important_. Before proceeding, please review the Knative community
 [Code of Conduct](./CODE-OF-CONDUCT.md).
 
@@ -23,14 +22,15 @@ Other Documents
 
 - [Code of Conduct](./CODE-OF-CONDUCT.md) - all contributors must abide by the
   code of conduct
-- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on becoming
-  a contributor
+- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on
+  becoming a contributor
 - [Working Groups](./WORKING-GROUPS.md) - describes our various working groups
-- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how working
-  groups operate
+- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how
+  working groups operate
 - [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE.md) - describes our
   technical oversight committee
-- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering committee
+- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering
+  committee
 - [Community Roles](./ROLES.md) - describes the roles individuals can assume
   within the Knative community
 - [Reviewing and Merging Pull Requests](./REVIEWING.md) - how we manage pull
@@ -39,8 +39,8 @@ Other Documents
 ## Introduction
 
 Knative is a Kubernetes-based platform to build, deploy, and manage modern
-serverless workloads. See [Knative docs](../docs/README.md) for
-in-depth information about using Knative.
+serverless workloads. See [Knative docs](../docs/README.md) for in-depth
+information about using Knative.
 
 ## Knative authors
 
@@ -56,15 +56,15 @@ 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](../community/samples/README.md).  These documents
-are contributed, reviewed, and maintained by the community.
+[Community Samples](../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-CONTRIBUTING.md), but it helps if you follow it 
-as you write your tutorial.
+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-CONTRIBUTING.md), but it helps if
+you follow it as you write your tutorial.
 
 ## Meetings and work groups
 
@@ -98,7 +98,8 @@ following resources are available for you:
 - [Knative Users](https://groups.google.com/forum/#!forum/knative-users)
 - [Knative Developers](https://groups.google.com/forum/#!forum/knative-dev)
 
-For contributors to Knative, we also have [Knative Slack](./SLACK-GUIDELINES.md).
+For contributors to Knative, we also have
+[Knative Slack](./SLACK-GUIDELINES.md).
 
 ---
 

diff --git a/contributing/REVIEWING.md b/contributing/REVIEWING.md
@@ -30,8 +30,8 @@ Please do not ever hesitate to ask a question or submit a PR.
 
 Reviewers are often the first points of contact between new members of the
 community and are important in shaping the community. We encourage reviewers to
-read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and
-beyond the code of conduct to promote a collaborative and respectful community.
+read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and beyond the
+code of conduct to promote a collaborative and respectful community.
 
 ## Code reviewers
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,3 @@ linkTitle: "Articles"
		weight: 30
		type: "blog"
		---