[doc] formatting fixes for mkdocs

Author: knopers8

README.md

@@ -62,6 +62,7 @@ There are two ways of interacting with AliECS:
 ### I want my application to send requests to AliECS
 
 :scroll: See the API docs of AliECS components:
+
 - [core gRPC server](/docs/apidocs_aliecs.md)
 - [apricot gRPC server](/docs/apidocs_apricot.md)
 - [apricot HTTP server](/apricot/docs/apricot_http_service.md)

apricot/README.md

@@ -4,6 +4,7 @@
 It adds templating, load balancing and caching on top of the configuration store.
 
 See also:
+
 * [apricot HTTP service](docs/apricot_http_service.md) - make essential cluster information available via a web server
 * Protofile: [apricot.proto](protos/apricot.proto)
 * [Command reference](docs/apricot.md)

coconut/README.md

@@ -98,6 +98,7 @@ A valid workflow template (sometimes called simply "workflow" for brevity) must
 
 Workflows and tasks are managed with a git based configuration system, so the workflow template may be provided simply by name or with repository and branch/tag/hash constraints.
 Examples:
+
  * `coconut env create -w myworkflow` - loads workflow `myworkflow` from default configuration repository at HEAD of master branch
  * `coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow` - loads a workflow from a specific git repository, HEAD of master branch
  * `coconut env create -w myworkflow@rev` - loads a workflow from default repository, on branch, tag or revision `rev`

coconut/doc/coconut_environment_create.md

@@ -13,6 +13,7 @@ A valid workflow template (sometimes called simply "workflow" for brevity) must
 
 Workflows and tasks are managed with a git based configuration system, so the workflow template may be provided simply by name or with repository and branch/tag/hash constraints.
 Examples:
+
  * `coconut env create -w myworkflow` - loads workflow `myworkflow` from default configuration repository at HEAD of master branch
  * `coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow` - loads a workflow from a specific git repository, HEAD of master branch
  * `coconut env create -w myworkflow@rev` - loads a workflow from default repository, on branch, tag or revision `rev`

coconut/doc/coconut_repository.md

@@ -9,6 +9,7 @@ The repository command performs operations on the repositories used for task and
 A valid workflow configuration repository must contain the directories `tasks` and `workflows` in its `master` branch.
 
 When referencing a repository, the clone method should never be prepended. Supported repo backends and their expected format are:
+
 - https: [hostname]/[repo_path]
 - ssh: [hostname]:[repo_path]
 - local [repo_path] (local repo entries are ephemeral and will not survive a core restart)

coconut/doc/coconut_repository_add.md

@@ -16,6 +16,7 @@ the ensuing list is followed until a valid revision has been identified:
 Exhaustion of the aforementioned list results in a repo add failure.
 
 `coconut repo add` can be called with
+
 1) a repository identifier
 2) a repository identifier coupled with the `--default-revision` flag (see examples below)
 

coconut/doc/coconut_role_query.md

@@ -17,6 +17,7 @@ walk through the role tree of the given environment, starting from the root role
 per https://github.com/gobwas/glob syntax.
 
 Examples:
+
  * `coconut role query 2rE9AV3m1HL readout-dataflow` - queries the role `readout-dataflow` in environment `2rE9AV3m1HL`, prints the full tree, along with the variables defined in the root role
  * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab102` - queries the role `readout-dataflow.host-aido2-bld4-lab102`, prints the subtree of that role, along with the variables defined in it
  * `coconut role query 2rE9AV3m1HL readout-dataflow.host-aido2-bld4-lab102.data-distribution.stfs` - queries the role at the given path, it is a task role so there is no subtree, prints the variables defined in that role

coconut/doc/coconut_template_list.md

@@ -7,7 +7,8 @@ list available workflow templates
 The template list command shows a list of available workflow templates.
 These workflow templates can then be loaded to create an environment.
 
-`coconut templ list` can be called with 
+`coconut templ list` can be called with
+
 1) a combination of the `--repo` , `--revision` , `--all-branches` , `--all-tags` , `--all-workflows` flags, or with
 2) an argument in the form of [repo-pattern]@[revision-pattern], where the patterns are globbing.
 

core/integration/README.md

@@ -9,6 +9,7 @@ All plugins should implement the [`Plugin`](/core/integration/plugin.go) interfa
 See the existing plugins for examples.
 
 In order to have the plugin loaded by the AliECS, one has to:
+
 - add `RegisterPlugin` to the `init()` function in [AliECS core main source](https://github.com/AliceO2Group/Control/blob/master/cmd/o2-aliecs-core/main.go)
 - add plugin name in the `integrationPlugins` list and set the endpoint in the AliECS configuration file (typically at `/o2/components/aliecs/ANY/any/settings` in the configuration store)
 

docs/handbook/configuration.md

@@ -12,6 +12,7 @@ while still being powerful enough to express complex workflows.
 
 To instantiate a data taking activity, or environment, two kinds of files
 are needed:
+
 * workflow templates
 * task templates
 
@@ -196,6 +197,7 @@ for examples of call roles that reference a variety of integration plugins.
 #### Workflow hook call structure
 
 The state machine callback moments are exposed to the AliECS workflow template interface and can be used as triggers or synchronization points for integration plugin function calls. The `call` block can be used for this purpose, with similar syntax to the `task` block used for controllable tasks. Its fields are as follows.
+
 * `func` - mandatory, it parses as an [`antonmedv/expr`](https://github.com/antonmedv/expr) expression that corresponds to a call to a function that belongs to an integration plugin object (e.g. `bookkeeping.StartOfRun()`, `dcs.EndOfRun()`, etc.).
 * `trigger` - mandatory, the expression at `func` will be executed once the state machine reaches this moment. For possible values, see [State machine triggers](/docs/handbook/operation_order.md#state-machine-triggers)
 * `await` - optional, if absent it defaults to the same as `trigger`, the expression at `func` needs to finish by this moment, and the state machine will block until `func` completes.
@@ -410,10 +412,12 @@ Variables whose availability to tasks is handled in some way by AliECS include
  * variables delivered to tasks explicitly via task templates.
 
 The latter can be
+
  * sourced from Apricot with a query from the task template iself (e.g. `config.Get`), or
  * sourced from the variables available to the current AliECS environment, as defined in the workflow template (e.g. readout-dataflow.yaml)
 
 Depending on the specification in the task template (`command.env`, `command.arguments` or `properties`), the push to the given task can happen
+
  * as system environment variables on task startup,
  * as command line parameters on task startup, or
  * as (FairMQ) key-values during `CONFIGURE`.
@@ -441,6 +445,7 @@ In addition to the above, which varies depending on the configuration of the env
  * `pdp_override_run_start_time`
 
 The following values are pushed by AliECS during `STOP_ACTIVITY`:
+
  * `run_end_time_ms`
 
 FairMQ task implementors should expect that these values are written to the FairMQ properties map right before the `RUN` and `STOP` transitions via `SetProperty` calls.