Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/fix some docs #3359

Merged
merged 6 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/docs/20-usage/40-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ once their usage is declared in the `secrets` section:
Alternatively, you can get a `setting` from secrets using the `from_secret` syntax.
In this example, the secret named `secret_token` would be passed to the setting named `token`, which will be available in the plugin as environment variable named `PLUGIN_TOKEN`. See [Plugins](./51-plugins/20-creating-plugins.md#settings) for details.

**NOTE:** the `from_secret` syntax only works with the newer `settings` block.
:::note
The `from_secret` syntax only works with the newer `settings` block.
:::

```diff
steps:
Expand Down Expand Up @@ -77,7 +79,9 @@ There may be scenarios where you are required to store secrets using alternate n

Secrets are not exposed to pull requests by default. You can override this behavior by creating the secret and enabling the `pull_request` event type, either in UI or by CLI, see below.

**NOTE:** Please be careful when exposing secrets to pull requests. If your repository is open source and accepts pull requests your secrets are not safe. A bad actor can submit a malicious pull request that exposes your secrets.
:::note
Please be careful when exposing secrets to pull requests. If your repository is open source and accepts pull requests your secrets are not safe. A bad actor can submit a malicious pull request that exposes your secrets.
:::

## Image filter

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/30-administration/22-backends/20-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pipeline can be trusted. You shouldn't use it for a public facing CI where
anyone can submit code or add new repositories. You shouldn't execute the agent
as a privileged user (root).

The local backend will use a random directory in $TMPDIR to store the cloned
The local backend will use a random directory in `$TMPDIR` to store the cloned
code and execute commands.

In order to use this backend, you need to download (or build) the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Custom agent backends
# Custom backends

If none of our backends fits your usecases, you can write your own.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/30-administration/60-ssl.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Update your configuration to mount your certificate and key:

Update your configuration to provide the paths of your certificate and key:

```yaml title="docker-compose.yaml"
```diff title="docker-compose.yaml"
version: '3'

services:
Expand Down