doc improvements — radicle-ci-broker

rad:zwTxygwuz5LDGBq255RA2CbNGrz8

Radicle CI broker

doc improvements

Merged did:key:z6MkfPSK...sonK opened 10 months ago

1 file changed +12 -12 073b652f → 97a904c6

modified doc/userguide.md

@@ -20,7 +20,7 @@ and quite popular definition, if not very purist.)

 The Radicle node stores Git repositories and synchronizes them with
 other Radicle nodes. The CI broker connects to its local node and gets
 "node events" whenever anything changes in the node. The relevant
 change for the CI broker is that a Git references ("refs") in a
 change for the CI broker is that Git references ("refs") in a
 repository have been created, updated, or deleted. For now, these are
 branches. Later, Radicle and the CI broker will support other
 references, such as tags.

@@ -30,9 +30,9 @@ deleted. It's not possible to create a Radicle repository without

 creating a branch, so just looking at references is enough.
 The CI broker looks at the reference changes and refines them into "CI
 events", which are more suitable for the kind CI use that the CI
 broker is meant to enable, than "this ref changed", which is quite low
 level.
 events", which are more suitable for the kind of CI use that the CI
 broker is meant to enable. That is, it does not care about all
 "this ref changed" events, which are quite low level.
 The CI events are filtered, and events that are allowed by the filter
 trigger a CI run, which runs another program called the CI adapter.

@@ -47,13 +47,13 @@ configuration to suit the CI system it targets.

 To use Radicle CI, you first need to have a Radicle node where you
 want to run CI. Due to technical limitations, this can't be your usual
 node, because it won't react to changes you push to it, only to
 node, because it won't react to changes you push to it. It will only react to
 changes it receives from other nodes.
 Once you've [installed a Radicle node and it is
 running](https://radicle.xyz/#get-started):
 * Install the Radicle CI broker. Currently this is easiest to by
 * Install the Radicle CI broker. One way to do that is by
   building the latest release from source. This requires the Rust
   compiler and tools to be installed.

@@ -69,7 +69,7 @@ cargo install radicle-native-ci --locked

 ~~~
 * Create a configuration file. You can call the file anything you like
   (the example below assumes `cib.yaml`). You should ensure the
   (the example below assumes `ci-broker.yaml`). You should ensure the
   Radicle node below is your normal node. You should make sure the
   `report_dir` field points to a directory that exists. The example
   below assumes `_rad` user; adjust paths as necessary.

@@ -98,7 +98,7 @@ triggers:

 ~~~
 * Create a configuration file for the native CI adapter. Place it in
   the location specified in `cib.yaml` above in the
   the location specified in `ci-broker.yaml` above in the
   `RADICLE_NATIVE_CI` environment variable.
 ~~~yaml

@@ -110,7 +110,7 @@ base_url: http://setup-ci/

 * Start the CI adapter:
 ~~~sh
 cib --config cib.yaml process-events
 cib --config ci-broker.yaml process-events
 ~~~
 You can also set up a web server to serve the files in `report_dir`

@@ -149,7 +149,7 @@ Check the report file to see that it works.

   published.
 If all works, excellent. If not, and you need help, drop by the
 [Radicle Zulip](https://radicle.zulipchat.com/) chat for ask for help.
 [Radicle Zulip](https://radicle.zulipchat.com/) chat to ask for help.
 Next, you probably want to consider what adapter you want to use. See
 the

@@ -204,7 +204,7 @@ triggers:

 ~~~
 * Create `~/.config/ambient/config.yaml` (adjust the various fields
   for how much resource usage want to allow, and paths):
   for how much resource usage to allow, and paths):
 ~~~yaml
 tmpdir: /tmp

@@ -448,7 +448,7 @@ must be one of the operands from the table above. Simple values are

 expressed as doubly quoted strings, and lists of operands are
 sub-lists in YAML syntax.
 The `filters` field is a list of filter expressions that implicitly
 The `filters` field is a list of filter expressions that are implicitly
 joined together using '!Or` -- in other words, if any of the
 expressions in the list allows the event, the whole list allows the
 events.