diff --git a/.gitpod.yml b/.gitpod.yml index 42bb481c1..12b5b761a 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -95,3 +95,4 @@ vscode: - "johnsoncodehk.volar" - "redhat.vscode-yaml" - "davidanson.vscode-markdownlint" + - "streetsidesoftware.code-spell-checker" diff --git a/docs/docs/30-administration/15-agent-config.md b/docs/docs/30-administration/15-agent-config.md index ed101fbe7..63c461b2e 100644 --- a/docs/docs/30-administration/15-agent-config.md +++ b/docs/docs/30-administration/15-agent-config.md @@ -21,7 +21,7 @@ The following are automatically set and can be overridden: ## 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 # docker-compose.yml diff --git a/docs/docs/30-administration/70-proxy.md b/docs/docs/30-administration/70-proxy.md index 2d68167f4..a80774c26 100644 --- a/docs/docs/30-administration/70-proxy.md +++ b/docs/docs/30-administration/70-proxy.md @@ -2,7 +2,7 @@ ## 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 ProxyPreserveHost On @@ -33,7 +33,7 @@ ProxyPassReverse / http://127.0.0.1:8000/ ## 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: @@ -80,7 +80,7 @@ server { ## 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 woodpecker.example.com { diff --git a/docs/docs/92-development/05-architecture.md b/docs/docs/92-development/05-architecture.md index 1ebb5bc34..36fd44ddb 100644 --- a/docs/docs/92-development/05-architecture.md +++ b/docs/docs/92-development/05-architecture.md @@ -6,11 +6,11 @@ ## System architecture -### main package hirarchie +### main package hierarchy | 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` | `cli/**` | code only cli tool does need | `pipeline`, `shared`, `woodpecker-go` | `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/model/**` | structs for store (db) and api (json) | std | `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/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` @@ -39,7 +39,6 @@ * `../` = `server/` - ### Agent TODO