Skip to content

Commit 5f56a4e

Browse files
lijianguojianxiaoguo
authored andcommitted
chore(workflow):replace the special words
1 parent e8634c9 commit 5f56a4e

14 files changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ We welcome your input! If you have feedback, please [submit an issue][issues]. I
2828

2929
# Working on Documentation
3030

31-
[![Build Status](https://travis-ci.org/drycc/workflow.svg?branch=master)](https://travis-ci.org/drycc/workflow)
31+
[![Build Status](https://travis-ci.org/drycc/workflow.svg?branch=main)](https://travis-ci.org/drycc/workflow)
3232
[![Latest Docs](http://img.shields.io/badge/docs-latest-fc1e5e.svg)](http://docs-v2.readthedocs.org/en/latest/)
3333

3434
The Drycc project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.

charts/workflow/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ global:
7171
use_rbac: true
7272
# Please check `kubernetes.io/ingress.class`
7373
# The cert-manager component must be installed
74-
# If you want to use HTTPSEnforced or whitelist functions, you must specify:
74+
# If you want to use HTTPSEnforced or allowlist functions, you must specify:
7575
# - nginx
7676
# - traefik
7777
# Only the above options have been supported so far

src/contributing/development-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ $ cd <component>
9595
!!! note
9696
By checking out the forked copy into the namespace `github.com/drycc/<component>`, we are tricking the Go toolchain into seeing our fork as the "official" source tree.
9797

98-
If you are going to be issuing pull requests to the upstream repository from which you forked, we suggest configuring Git such that you can easily rebase your code to the upstream repository's master branch. There are various strategies for doing this, but the [most common](https://help.github.com/articles/fork-a-repo/) is to add an `upstream` remote:
98+
If you are going to be issuing pull requests to the upstream repository from which you forked, we suggest configuring Git such that you can easily rebase your code to the upstream repository's main branch. There are various strategies for doing this, but the [most common](https://help.github.com/articles/fork-a-repo/) is to add an `upstream` remote:
9999

100100
```
101101
$ git remote add upstream https://github.com/drycc/<component>.git

src/contributing/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Interact with the community on our user mailing list or live in our [Drycc #comm
3838
[dd]: design-documents.md
3939
[dev-environment]: development-environment.md
4040
[easy fix]: https://github.com/pulls?utf8=%E2%9C%93&q=user%3Adrycc+label%3A%22easy+fix%22+is%3Aopen
41-
[dco]: https://github.com/drycc/workflow/blob/master/DCO
41+
[dco]: https://github.com/drycc/workflow/blob/main/DCO
4242
[help wanted]: https://github.com/pulls?utf8=%E2%9C%93&q=user%3Adrycc+label%3A%22help+wanted%22+is%3Aopen
4343
[troubleshooting]: ../troubleshooting/index.md
4444
[issues]: https://github.com/pulls?utf8=%E2%9C%93&q=user%3Adrycc+user%3Ahelm

src/installing-workflow/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ More rigorous installations would benefit from using outside sources for the fol
3535

3636
#### Ingress
3737

38-
Now, workflow requires that ingress and cert-manager must be installed. Any compatible Kubernetes entry controller can be used, but only ingress-nginx and ingress-traefik currently support enforced HTTPS and whitelist. Enable entries in accordance with [this guide](./ingress.md).
38+
Now, workflow requires that ingress and cert-manager must be installed. Any compatible Kubernetes entry controller can be used, but only ingress-nginx and ingress-traefik currently support enforced HTTPS and allowlist. Enable entries in accordance with [this guide](./ingress.md).
3939

4040
## Add the Drycc Chart Repository
4141

src/installing-workflow/system-requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Drycc Workflow requires Kubernetes v1.16.15 or later.
99
## Components Requirements
1010

1111
Drycc uses ingress as a routing implementation, so you have to choose an ingress.
12-
We recommend using [nginx-ingress](https://github.com/helm/charts/tree/master/stable/nginx-ingress) or [traefik-ingress](https://github.com/helm/charts/tree/master/stable/traefik), which we have adapted to whitelist and force TLS functions.
12+
We recommend using [nginx-ingress](https://github.com/helm/charts/tree/master/stable/nginx-ingress) or [traefik-ingress](https://github.com/helm/charts/tree/master/stable/traefik), which we have adapted to allowlist and force TLS functions.
1313

1414
Workflow supports the use of ACME to manage automatic certificates, [cert-manager](https://github.com/helm/charts/tree/master/stable/cert-manager) is also one of the necessary components.
1515

1616
Workflow supports stateful apps. You can create and use them through the 'drycc volumes' command. If you want to use this feature, you must have a `StorageClass` that supports `ReadWriteMany`.
17-
17+
1818
Workflow also supports the [OSB](https://github.com/openservicebrokerapi/servicebroker) API through the 'drycc resources' command. If you want to use this function, you need to install [service-catalog](https://svc-cat.io).
1919

2020
## Storage Requirements

src/managing-workflow/platform-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The logging platform is made up of 2 components - [Fluentd](https://github.com/drycc/fluentd) and [Logger](https://github.com/drycc/logger).
44

5-
[Fluentd](https://github.com/drycc/fluentd) runs on every worker node of the cluster and is deployed as a [Daemon Set](http://kubernetes.io/v1.1/docs/admin/daemons.html). The Fluentd pods capture all of the stderr and stdout streams of every container running on the host (even those not hosted directly by kubernetes). Once the log message arrives in our [custom fluentd plugin](https://github.com/drycc/fluentd/tree/master/rootfs/opt/fluentd/drycc-output) we determine where the message originated.
5+
[Fluentd](https://github.com/drycc/fluentd) runs on every worker node of the cluster and is deployed as a [Daemon Set](http://kubernetes.io/v1.1/docs/admin/daemons.html). The Fluentd pods capture all of the stderr and stdout streams of every container running on the host (even those not hosted directly by kubernetes). Once the log message arrives in our [custom fluentd plugin](https://github.com/drycc/fluentd/tree/main/rootfs/opt/fluentd/drycc-output) we determine where the message originated.
66

77
If the message was from the [Workflow Controller](https://github.com/drycc/controller) or from an application deployed via workflow we send it to the logs topic on the local [NSQD](http://nsq.io) instance.
88

src/managing-workflow/platform-monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A production install of Grafana should have the following configuration values c
5454

5555
* Change the default username and password from `admin/admin`. The value for the password is passed in plain text so it is best to set this value on the command line instead of checking it into version control.
5656
* Enable persistence
57-
* Use a supported external database such as mysql or postgres. You can find more information [here](https://github.com/drycc/monitor/blob/master/grafana/rootfs/usr/share/grafana/grafana.ini.tpl#L62)
57+
* Use a supported external database such as mysql or postgres. You can find more information [here](https://github.com/drycc/monitor/blob/main/grafana/rootfs/usr/share/grafana/grafana.ini.tpl#L62)
5858

5959

6060
### On Cluster Persistence
@@ -109,7 +109,7 @@ Telegraf is the metrics collection daemon used within the monitoring stack. It w
109109
* Container level metrics such as CPU and Memory
110110
* Kubernetes metrics such as API request latency, Pod Startup Latency, and number of running pods
111111

112-
It is possible to send these metrics to other endpoints besides InfluxDB. For more information please consult the following [file](https://github.com/drycc/monitor/blob/master/telegraf/rootfs/config.toml.tpl)
112+
It is possible to send these metrics to other endpoints besides InfluxDB. For more information please consult the following [file](https://github.com/drycc/monitor/blob/main/telegraf/rootfs/config.toml.tpl)
113113

114114
### Customizing the Monitoring Stack
115115

src/managing-workflow/tuning-component-settings.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ BACKUPS_TO_RETAIN | number of base backups the backing store should retain (defa
112112

113113
## Customizing Fluentd
114114

115-
The following values can be changed in the `values.yaml` file or by using the `--set` flag with the Helm CLI.
115+
The following values can be changed in the `values.yaml` file or by using the `--set` flag with the Helm CLI.
116116

117117
Key | Default | Description
118118
------------------| --------| ---------------------------------
@@ -129,7 +129,7 @@ output.disable_drycc | false | Disable the Drycc output plugin
129129
boot.install_build_tools | false | Install the build tools package. This is useful when using custom plugins
130130
daemon_environment | | Takes key-value pairs and turns them into environment variables.
131131

132-
For more information about the various environment variables that can be set please see the [README](https://github.com/drycc/fluentd/blob/master/README.md)
132+
For more information about the various environment variables that can be set please see the [README](https://github.com/drycc/fluentd/blob/main/README.md)
133133

134134
## Customizing the Logger
135135

@@ -151,18 +151,18 @@ user | "admin" | The first user created in the database (this user has admin p
151151
password | "admin" | Password for the first user.
152152
allow_sign_up | "true" | Allows users to sign up for an account.
153153

154-
For a list of other options you can set by using environment variables please see the [configuration file](https://github.com/drycc/monitor/blob/master/grafana/rootfs/usr/share/grafana/grafana.ini.tpl) in Github.
154+
For a list of other options you can set by using environment variables please see the [configuration file](https://github.com/drycc/monitor/blob/main/grafana/rootfs/usr/share/grafana/grafana.ini.tpl) in Github.
155155

156156
### [Telegraf](https://docs.influxdata.com/telegraf)
157-
For a list of configuration values that can be set by using environment variables please see the following [configuration file](https://github.com/drycc/monitor/blob/master/telegraf/rootfs/config.toml.tpl).
157+
For a list of configuration values that can be set by using environment variables please see the following [configuration file](https://github.com/drycc/monitor/blob/main/telegraf/rootfs/config.toml.tpl).
158158

159159
### [InfluxDB](https://docs.influxdata.com/influxdb)
160-
You can find a list of values that can be set using environment variables [here](https://github.com/drycc/monitor/blob/master/influxdb/rootfs/home/influxdb/config.toml.tpl).
160+
You can find a list of values that can be set using environment variables [here](https://github.com/drycc/monitor/blob/main/influxdb/rootfs/home/influxdb/config.toml.tpl).
161161

162162
## Customizing the Registry
163163

164164
The [Registry][] component can be tuned by following the
165-
[drycc/distribution config doc](https://github.com/drycc/distribution/blob/master/docs/configuration.md).
165+
[drycc/distribution config doc](https://github.com/drycc/distribution/blob/main/docs/configuration.md).
166166

167167
## Customizing the Router
168168

src/managing-workflow/upgrading-workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ drycc-registry-proxy-zyajl 1/1 Running 0 5m
8080
Users of Drycc Workflow should now upgrade their drycc client to avoid getting `WARNING: Client and server API versions do not match. Please consider upgrading.` warnings.
8181

8282
```
83-
curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/master/install-v2.sh | bash -s v2.20.0 && sudo mv drycc $(which drycc)
83+
curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install-v2.sh | bash -s v2.20.0 && sudo mv drycc $(which drycc)
8484
```
8585

8686

8787
[minio]: https://github.com/drycc/minio
8888
[Configuring Object Storage]: ../installing-workflow/configuring-object-storage.md
89-
[Workflow-Migration]: https://github.com/drycc/workflow-migration/blob/master/README.md
89+
[Workflow-Migration]: https://github.com/drycc/workflow-migration/blob/main/README.md

0 commit comments

Comments
 (0)