Skip to content

Commit f4f5cab

Browse files
committed
docs(*): improve grammar and fix typos
1 parent a85e28b commit f4f5cab

5 files changed

Lines changed: 46 additions & 49 deletions

File tree

src/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Welcome to Deis Workflow
22

3-
Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any Kubernetes cluster, making it easy to deploy and manage applications on your own servers. It includes capabilities for building and deploying from source via git push, configuring your applications, managing and rolling back releases, managing application domain names and SSL certificates, edge routing, application log aggregation, and managing access to application resources. All of this is exposed through a simple REST API and command line interface.
3+
Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any Kubernetes cluster, making it easy to deploy and manage applications on your own servers.
44

5-
For more detailed information about Workflow view the [Concepts][concepts] and [Architecture][arch] sections.
5+
Workflow includes capabilities for building and deploying from source via `git push`, configuring your applications, creating and rolling back releases, managing application domain names and SSL certificates, providing edge routing, aggregating application logs, and controlling access to application resources. All of this is exposed through a simple REST API and command line interface.
6+
7+
For more detailed information about Workflow, view the [Concepts][concepts] and [Architecture][arch] sections.
68

79
To get started with Workflow, follow our [Quick Start][quickstart] guide.
810

src/installing-workflow/installing-deis-workflow.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ We will use the Helm package manager for Kubernetes to install Deis Workflow ont
44

55
## Check Your Setup
66

7-
First check that you have `helm` installed and the version is correct.
7+
First check that the `helm` command is available and the version is 0.6 or newer.
88

99
```
1010
$ helm --version
11-
0.4.0
11+
helm version 0.6.0+1c8688e
1212
```
1313

14-
Ensure your kubectl client is installed and ensure it can connect to your Kubernetes cluster. This
15-
is where Helm will attempt to communicate with the cluster. You can test that it is working
16-
properly by running:
14+
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helm` will
15+
use it to communicate. You can test that it is working properly by running:
1716

1817
```
1918
$ helm target
@@ -25,7 +24,7 @@ Grafana is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/ser
2524
InfluxDB is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb
2625
```
2726

28-
If you see a list of targets like the one above, 'helm' can communicate with the kubernetes master.
27+
If you see a list of targets like the one above, `helm` can communicate with the Kubernetes master.
2928

3029
Deis Workflow requires Kubernetes 1.2 or higher. You can test that by running:
3130

src/installing-workflow/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ These steps will help you install and configure Deis Workflow on a Kubernetes cl
44

55
## Check System Requirements
66

7-
Please refer to the prerequisites and [system requirements][] for considerations when planning your Kubernetes environment.
7+
Please refer to the [system requirements][] for considerations when planning your Kubernetes environment.
88

99
## Choose a Provider
1010

src/installing-workflow/system-requirements.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,9 @@ Deis workflow has been tested with the Kubernetes v1.2 release line. It is incom
2222

2323
# Docker Requirements
2424

25-
## Docker Version
26-
27-
Any Kubernetes 1.1 cluster should also use a Docker version < 1.10.0 so that `kubectl exec` and Deis database health checks work properly (Refs: [fsouza/go-dockerclient#455](https://github.com/fsouza/go-dockerclient/issues/455) and [kubernetes/kubernetes#19720](https://github.com/kubernetes/kubernetes/issues/19720)).
28-
2925
## Docker Insecure Registry
3026

31-
The on-cluster, Deis-managed Docker registry is not deployed with TLS by default. As such, all Kubernetes worker nodes must have their Docker daemons configured to use an insecure registry. The subnet should encompass any private networks used by your worker nodes including any overlay networks. Depending on your Kubernetes and Docker configuration, setting `EXTRA_DOCKER_OPTS="--insecure-registry=10.0.0.0/8"` may be sufficient.
27+
The on-cluster, Deis-managed Docker registry is not deployed with TLS by default. As such, all Kubernetes worker nodes must have their Docker daemons configured to use an insecure registry. The subnet should encompass any private networks used by your worker nodes, including any overlay networks. Depending on your Kubernetes and Docker configuration, setting `EXTRA_DOCKER_OPTS="--insecure-registry=10.0.0.0/8"` may be sufficient.
3228

3329
## SELinux + OverlayFS
3430

src/understanding-workflow/concepts.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Twelve-Factor apps as containers across a Kubernetes cluster.
88
The [Twelve-Factor App][] is a methodology for building modern
99
applications that can be scaled across a distributed system.
1010

11-
We consider it an invaluable synthesis of much experience with
12-
software-as-a-service apps in the wild, especially on the
11+
Twelve-factor is a valuable synthesis of years of experience with
12+
software-as-a-service apps in the wild, particularly on the
1313
Heroku platform.
1414

1515
Workflow is designed to run applications that adhere to the [Twelve-Factor App][]
@@ -23,14 +23,15 @@ the activity on your cluster, including: desired state convergence, stable
2323
service addresses, health monitoring, service discovery, and DNS resolution.
2424

2525
Workflow builds upon Kubernetes abstractions like Services, Replication
26-
Controllers and Pods to provide a developer-friendly UX, source to image, log
27-
aggregation, etc.
26+
Controllers, and Pods to provide a developer-friendly experience. Building containers
27+
directly from application source code, aggregating logs, and managing deployment
28+
configurations and app releases are just some of the features Workflow adds.
2829

29-
Workflow is shipped as a Kubernetes-native application, installable via
30-
[Helm][helm], so operators familiar with Kubernetes will feel right at home
31-
running Workflow.
30+
Deis Workflow is a set of Kubernetes-native components, installable via
31+
[Helm][helm]. Systems engineers who are familiar with Kubernetes will feel right
32+
at home running Workflow.
3233

33-
For a detailed overview of Workflow components, see our [component][components] break down.
34+
See the [components][components] overview for more detail.
3435

3536
## Docker
3637

@@ -46,23 +47,23 @@ Applications which are packaged via a buildpack are run in Docker containers as
4647
part of the `slugrunner` process. View the [slugrunner component][slugrunner]
4748
for more information.
4849

49-
Applications which use either a Dockerfile or reference an external Docker
50-
Image are launched unmodified.
50+
Applications which use either a Dockerfile or reference external Docker
51+
images are launched unmodified.
5152

5253
## Applications
5354

5455
Workflow is designed around the concept of an [application][], or app.
5556

56-
Applications can come in three forms:
57+
Applications come in one of three forms:
5758

58-
1. as collection of source files stored in a Git repository
59-
2. as a Dockerfile, which describes how to build your app
60-
3. a reference to an already built Docker Image, hosted on a remote Docker repository
59+
1. a collection of source files stored in a `git` repository
60+
2. a Dockerfile and associated source files stored in a `git` repository
61+
3. a reference to an existing image at a Docker repository
6162

62-
Applications identified by a unique name for easy reference. If you do not
63-
specify a name when creating your application Workflow generates one for you.
64-
Workflow also tracks other related information for your application including
65-
any domain names, SSL Certificates and developer provided configuration.
63+
Applications are identified by a unique name for easy reference. If you do not
64+
specify a name when creating your application, Workflow generates one for you.
65+
Workflow also manages related information, including domain names, SSL
66+
certificates, and developer-provided configuration.
6667

6768
## Build, Release, Run
6869

@@ -73,33 +74,32 @@ any domain names, SSL Certificates and developer provided configuration.
7374
The [builder][] component processes incoming `git push deis master` requests
7475
and manages your application packaging.
7576

76-
If your application is using a [buildpack][buildpacks] builder will launch an ephemeral
77+
If your application is using a [buildpack][buildpacks], builder will launch an ephemeral
7778
job to extract and execute the packaging instructions. The resulting
7879
application artifact is stored by the platform for execution during the run
7980
stage.
8081

81-
If instead, you provide a [Dockerfile][dockerfile] builder will use the
82-
instructions you have provided to build a Docker Image. The resulting artifact is
83-
stored in a Deis-managed registry which will be referenced during the run
84-
stage.
82+
If instead builder finds a [Dockerfile][dockerfile], it follows those instructions to
83+
create a Docker image. The resulting artifact is stored in a Deis-managed registry which
84+
will be referenced during the run stage.
8585

86-
If you already have an external system building your application container you
87-
can simply reference that artifact. When using [external Docker
88-
images][dockerimage] the builder component doesn't attempt to repackage your
86+
If another system already builds and packages your application, that container
87+
artifact can be used directly. When referencing an [external Docker
88+
image][dockerimage], the builder component doesn't attempt to repackage your
8989
app.
9090

9191
### Release Stage
9292

9393
During the release stage, a [build][] is combined with [application configuration][config]
94-
to create a new numbered [release][]. New releases are created any time a new
95-
build is created or application configuration is changed. Tracking releases
96-
makes it easy to rollback to any previous release.
94+
to create a new, numbered [release][]. New releases are created any time a new
95+
build is created or application configuration is changed. Tracking releases as a
96+
"write-only ledger" this way makes it easy to rollback to any previous release.
9797

9898
### Run Stage
9999

100-
The run stage is responsible for deploying the new release to the underlying
101-
Kubernetes cluster. The run stage launches a new Replication Controller which
102-
references the new release. By managing the desired replica count, Workflow
100+
The run stage deploys the new release to the underlying Kubernetes cluster by
101+
launching a new Replication Controller which references the new release.
102+
By managing the desired replica count, Workflow
103103
orchestrates a zero-downtime, rolling update of your application. Once
104104
successfully updated, Workflow removes the last reference to the old release.
105105
Note that during the deploy, your application will be running in a mixed mode.
@@ -108,11 +108,11 @@ Note that during the deploy, your application will be running in a mixed mode.
108108

109109
Workflow treats all persistent services such as databases, caches, storage,
110110
messaging systems, and other [backing services][] as resources managed
111-
separtely from your application. This philosophy aligns with Twelve-Factor
111+
separately from your application. This philosophy aligns with Twelve-Factor
112112
best practices.
113113

114-
Applications are attached to backing services using [environment variables][].
115-
Because applications are decoupled from backing services, apps are free to
114+
Applications attach to backing services using [environment variables][].
115+
Because apps are decoupled from backing services, they are free to
116116
scale up independently, to use services provided by other apps, or to switch
117117
to external or third-party vendor services.
118118

0 commit comments

Comments
 (0)