Skip to content

Commit 5c405de

Browse files
committed
fix links
1 parent 1fc21a6 commit 5c405de

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ What is your use case?
2828

2929
* My software is a command line utility with no state machine
3030

31-
:palm_tree: Nothing to do, AliECS natively supports generic commands. Make sure the task template for your command sets the control mode to `basic` ([see example](https://github.com/AliceO2Group/ControlWorkflows/blob/basic-tasks/tasks/sleep.yaml)).
31+
:palm_tree: Nothing to do, AliECS natively supports generic commands. Make sure the task template for your command sets the control mode to `basic` ([see example](https://github.com/AliceO2Group/ControlWorkflows/blob/master/tasks/o2-roc-cleanup.yaml)).
3232

3333
* I want to build and run AliECS for **development** purposes
3434

docs/building.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Building AliECS
22

3-
> **WARNING**: The building instructions described in this page are **for development purposes only**. Users interested in deploying, running and controlling O²/FLP software or their own software with AliECS should refer to the [O²/FLP Suite instructions](../../installation/) instead.
3+
> **WARNING**: The building instructions described in this page are **for development purposes only**. Users interested in deploying, running and controlling O²/FLP software or their own software with AliECS should refer to the [O²/FLP Suite instructions](https://alice-flp.docs.cern.ch/Operations/Experts/system-configuration/utils/o2-flp-setup/) instead.
44
55

66
## Overview
@@ -85,6 +85,6 @@ You should find several executables including `o2control-core`, `o2control-execu
8585

8686
For subsequent builds (after the first one), plain `make` (instead of `make all`) is sufficient. See the [Makefile reference](makefile_reference.md) for more information.
8787

88-
If you wish to also build the process control library and/or plugin, see [the OCC readme](./occ/README.md).
88+
If you wish to also build the process control library and/or plugin, see [the OCC readme](/occ/README.md).
8989

90-
This build of AliECS can be run locally and connected to an existing O²/FLP Suite cluster by passing a `--mesosUrl` parameter. If you do this, remember to `systemctl stop o2-aliecs-core` on the head node, in order to stop the core that came with the O²/FLP Suite and use your own.
90+
This build of AliECS can be run locally and connected to an existing O²/FLP Suite cluster by passing a `--mesosUrl` parameter. If you do this, remember to `systemctl stop o2-aliecs-core` on the head node, in order to stop the core that came with the O²/FLP Suite and use your own.

docs/handbook/operation_order.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This chapter attempts to document the order of important operations done during
44
Since AliECS is an evolving system, the information presented here might be out-of-date, thus please refer to event handling in [core/environment/environment.go](https://github.com/AliceO2Group/Control/blob/master/core/environment/environment.go) and plugin calls in [ControlWorkflows/workflows/readout-dataflow.yaml](https://github.com/AliceO2Group/ControlWorkflows/blob/master/workflows/readout-dataflow.yaml) for the ultimate source of truth.
55
Also, please report to the ECS developers any inaccuracies.
66

7-
[State Machine Callbacks](configuration.md#State-machine-callbacks) documents the order of callbacks that can be associated with state machine transitions.
7+
[State Machine Callbacks](configuration.md#state-machine-callbacks-moments) documents the order of callbacks that can be associated with state machine transitions.
88

99
## START_ACTIVITY (Start Of Run)
1010

docs/handbook/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Design Overview
22

3-
AliECS in a distributed application, using Apache Mesos as toolkit. It integrates a task scheduler component, a purpose-built distributed state machine system, a multi-source stateful process configuration mechanism, and a control plugin and library compatible with any data-driven O2 process.
3+
AliECS is a distributed application, using Apache Mesos as toolkit. It integrates a task scheduler component, a purpose-built distributed state machine system, a multi-source stateful process configuration mechanism, and a control plugin and library compatible with any data-driven O2 process.
44

55
## AliECS Structure
66

@@ -25,7 +25,7 @@ Apache Mesos is a cluster resource management system. It greatly streamlines dis
2525

2626
For AliECS, Mesos acts as an authoritative source of knowledge on the state of the cluster, as well as providing transport facilities for communication between the AliECS core and the executor.
2727

28-
You can view the state of the cluster as presented by Mesos via the Mesos web interface, served on port `5050` of your head node when deployed via the [O²/FLP Suite setup tool](../../installation/).
28+
You can view the state of the cluster as presented by Mesos via the Mesos web interface, served on port `5050` of your head node when deployed via the O²/FLP Suite setup tool.
2929

3030

3131
## FairMQ
@@ -40,4 +40,4 @@ The main state machine of AliECS is the environment state machine, which represe
4040

4141
![](AliECS-envsm.svg)
4242

43-
While FairMQ devices use their own, FairMQ-specific state machine, non-FairMQ tasks based on the [OCC library](https://alice-flp-suite.docs.cern.ch/aliecs/occ/) use the same state machine as the AliECS environment state machine, the only difference being that the `START_ACTIVITY` transition is simply `START`, and the `STOP_ACTIVITY` transition is simply `STOP`.
43+
While FairMQ devices use their own, FairMQ-specific state machine, non-FairMQ tasks based on the [OCC library](/occ/README.md) use the same state machine as the AliECS environment state machine, the only difference being that the `START_ACTIVITY` transition is simply `START`, and the `STOP_ACTIVITY` transition is simply `STOP`.

docs/kafka.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Once the topics exist, no further messages can be lost and no action is necessar
2424

2525
### Currently available topics
2626

27-
See [events.proto](../common/protos/events.proto) for the protobuf definitions of the messages.
27+
See [events.proto](/common/protos/events.proto) for the protobuf definitions of the messages.
2828

2929
* `aliecs.core` - core events that don't concern a specific environment or task
3030
* `aliecs.environment` - events that concern an environment, e.g. environment state changes
@@ -38,7 +38,7 @@ See [events.proto](../common/protos/events.proto) for the protobuf definitions o
3838

3939
### Decoding the messages
4040

41-
Messages are encoded with protobuf, with the aforementioned [events.proto](../common/protos/events.proto) file defining the schema.
41+
Messages are encoded with protobuf, with the aforementioned [events.proto](/common/protos/events.proto) file defining the schema.
4242
Integraed service messages include a payload portion that is usually JSON-encoded, and has no predefined schema.
4343

4444
To generate the precompiled protobuf interface, run `make fdset`.
@@ -79,7 +79,7 @@ As for today, AliECS publishes on the following types of topics:
7979

8080
### Decoding the messages
8181

82-
Messages are encoded with protobuf. Please use [this](../core/integration/kafka/protos/kafka.proto) proto file to generate code which deserializes the messages.
82+
Messages are encoded with protobuf. Please use [this](/core/integration/kafka/protos/kafka.proto) proto file to generate code which deserializes the messages.
8383

8484
### Getting Start of Run and End of Run notifications
8585

docs/running.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Running AliECS as a developer
22

33

4-
> **WARNING**: The running instructions described in this page are **for development purposes only**. Users interested in deploying, running and controlling O²/FLP software or their own software with AliECS should refer to the [O²/FLP Suite instructions](https://alice-flp-suite.docs.cern.ch/installation/) instead.
4+
> **WARNING**: The running instructions described in this page are **for development purposes only**. Users interested in deploying, running and controlling O²/FLP software or their own software with AliECS should refer to the O²/FLP Suite instructions instead.
55
66

77
## Running the AliECS core
@@ -26,7 +26,7 @@ http://centosvmtest:5050/api/v1/scheduler
2626
--dumpWorkflows
2727
```
2828

29-
See [Using `coconut`](./coconut/README.md) for instructions on the O² Control core command line interface.
29+
See [Using `coconut`](/coconut/README.md) for instructions on the O² Control core command line interface.
3030

3131
# Running AliECS in production
3232

hacking/COG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ In production, AliECS will manage and push all configuration to active tasks, bu
4444

4545
Every task still has their own configuration file, with paths such as `/etc/flp.d/qc/*.json` for QualityControl and `/home/flp/readout.cfg` for Readout. These paths can be edited by the user, and any changes affect all newly launched instances of the task.
4646

47-
All configuration file paths used by tasks can be found in the task descriptors of the workflow configuration repository in use. For more information on workflow configuration repositories, see [the `coconut repository` reference](https://github.com/AliceO2Group/Control/blob/doc/coconut/doc/coconut_repository.md). The default workflow configuration repository which comes pre-loaded with AliECS is accessible at [AliceO2Group/ControlWorkflows](https://github.com/AliceO2Group/ControlWorkflows) (all task descriptor files are found in the `tasks` directory).
47+
All configuration file paths used by tasks can be found in the task descriptors of the workflow configuration repository in use. For more information on workflow configuration repositories, see [the `coconut repository` reference](/coconut/doc/coconut_repository.md). The default workflow configuration repository which comes pre-loaded with AliECS is accessible at [AliceO2Group/ControlWorkflows](https://github.com/AliceO2Group/ControlWorkflows) (all task descriptor files are found in the `tasks` directory).
4848

4949
* **modify an existing workflow or task?**
5050

51-
You are free to keep as many workflow configuration repositories as you wish in your AliECS instance. For more information on workflow configuration repositories, see [the `coconut repository` reference](https://github.com/AliceO2Group/Control/blob/doc/coconut/doc/coconut_repository.md).
51+
You are free to keep as many workflow configuration repositories as you wish in your AliECS instance. For more information on workflow configuration repositories, see [the `coconut repository` reference](/coconut/doc/coconut_repository.md).
5252

5353
Changes to a configuration repository are immediately available after running `coconut repo refresh`. There is no support in the AliECS GUI at this time.
5454

occ/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ See [`peanut` Overview](peanut/README.md).
5555

5656
## OCC API debugging with `grpcc`
5757

58-
See [OCC API debugging with `grpcc`](../docs/using_grpcc_occ.md).
58+
See [OCC API debugging with `grpcc`](/docs/using_grpcc_occ.md).

occ/occlib/examples/dummy-process/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This example is built from the top-level CMakeLists.txt when `BUILD_EXAMPLES` is true.
44

5-
For instructions on running it, see [Run example](../../../README.md#run-example).
5+
For instructions on running it, see [Run example](/occ/README.md#run-example).
66

77
## Standalone build
88

0 commit comments

Comments
 (0)