mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-09-29 06:51:59 +00:00
Code Issues Projects Releases Wiki Activity

Fix typos in docs (#1273)

Browse source 
Did used [cspell](https://www.npmjs.com/package/cspell) to find typos and fixed it.

Also add cspell to gitpod.

Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
This commit is contained in:
Yarden Shoham 2022-10-15 21:25:55 +03:00 committed by GitHub
parent e4fc1acd31
commit 4dbf3c671b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitpod.yml
View file

@ -95,3 +95,4 @@ vscode:
- "johnsoncodehk.volar" - "johnsoncodehk.volar"
- "redhat.vscode-yaml" - "redhat.vscode-yaml"
- "davidanson.vscode-markdownlint" - "davidanson.vscode-markdownlint"
- "streetsidesoftware.code-spell-checker"

2
docs/docs/30-administration/15-agent-config.md
View file

@ -21,7 +21,7 @@ The following are automatically set and can be overridden:
## Processes per agent ## Processes per agent
By default the maximum processes that are run per agent is 1. If required you can add `WOODPECKER_MAX_PROCS` to increase your parellel processing on a per-agent basis. By default the maximum processes that are run per agent is 1. If required you can add `WOODPECKER_MAX_PROCS` to increase your parallel processing on a per-agent basis.
```yaml ```yaml
# docker-compose.yml # docker-compose.yml

6
docs/docs/30-administration/70-proxy.md
View file

@ -2,7 +2,7 @@
## Apache ## Apache
This guide provides a brief overview for installing Woodpecker server behind the Apache2 webserver. This is an example configuration: This guide provides a brief overview for installing Woodpecker server behind the Apache2 web-server. This is an example configuration:
```nohighlight ```nohighlight
ProxyPreserveHost On ProxyPreserveHost On
@ -33,7 +33,7 @@ ProxyPassReverse / http://127.0.0.1:8000/
## Nginx ## Nginx
This guide provides a basic overview for installing Woodpecker server behind the nginx webserver. For more advanced configuration options please consult the official nginx [documentation](https://www.nginx.com/resources/admin-guide/). This guide provides a basic overview for installing Woodpecker server behind the nginx web-server. For more advanced configuration options please consult the official nginx [documentation](https://www.nginx.com/resources/admin-guide/).
Example configuration: Example configuration:
@ -80,7 +80,7 @@ server {
## Caddy ## Caddy
This guide provides a brief overview for installing Woodpecker server behind the [Caddy webserver](https://caddyserver.com/). This is an example caddyfile proxy configuration: This guide provides a brief overview for installing Woodpecker server behind the [Caddy web-server](https://caddyserver.com/). This is an example caddyfile proxy configuration:
```nohighlight ```nohighlight
woodpecker.example.com { woodpecker.example.com {

7
docs/docs/92-development/05-architecture.md
View file

@ -6,11 +6,11 @@
## System architecture ## System architecture
### main package hirarchie ### main package hierarchy
| package | meaning | imports | package | meaning | imports
|------------|--------------------------------------------------------------|---------- |------------|--------------------------------------------------------------|----------
| `cmd/**` | parse commanline args & environment to stat server/cli/agent | all other | `cmd/**` | parse command-line args & environment to stat server/cli/agent | all other
| `agent/**` | code only agent (remote worker) will need | `pipeline`, `shared` | `agent/**` | code only agent (remote worker) will need | `pipeline`, `shared`
| `cli/**` | code only cli tool does need | `pipeline`, `shared`, `woodpecker-go` | `cli/**` | code only cli tool does need | `pipeline`, `shared`, `woodpecker-go`
| `server/**`| code only server will need | `pipeline`, `shared` | `server/**`| code only server will need | `pipeline`, `shared`
@ -28,7 +28,7 @@
| `server/logging/**` | logging lib for gPRC server to stream logs while running | std | `server/logging/**` | logging lib for gPRC server to stream logs while running | std
| `server/model/**` | structs for store (db) and api (json) | std | `server/model/**` | structs for store (db) and api (json) | std
| `server/plugins/**` | plugins for server | `../model`, `../remote` | `server/plugins/**` | plugins for server | `../model`, `../remote`
| `server/pipeline/**`| orchistrate pipelines | `pipeline`, `../model`, `../pubsub`, `../queue`, `../remote`, `../store`, `../plugins` | `server/pipeline/**`| orchestrate pipelines | `pipeline`, `../model`, `../pubsub`, `../queue`, `../remote`, `../store`, `../plugins`
| `server/pubsub/**` | pubsub lib for server to push changes to the WebUI | std | `server/pubsub/**` | pubsub lib for server to push changes to the WebUI | std
| `server/queue/**` | queue lib for server where agents pull new pipelines from via gRPC | `server/model` | `server/queue/**` | queue lib for server where agents pull new pipelines from via gRPC | `server/model`
| `server/remote/**` | remote lib for server to connect and handle forge specific stuff | `shared`, `server/model` | `server/remote/**` | remote lib for server to connect and handle forge specific stuff | `shared`, `server/model`
@ -39,7 +39,6 @@
* `../` = `server/` * `../` = `server/`
### Agent ### Agent
TODO TODO