Skip to content

Documentation fixes #48

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.

Sign up for GitHub

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

Merged
henrikingo merged 2 commits into from
Apr 11, 2025
Merged

Documentation fixes #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce2af7f
Fix typos in documentation
ligurio Apr 4, 2025
b924b16
Describe BuildKit in installation guide
ligurio Apr 4, 2025
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
2 changes: 1 addition & 1 deletion docs/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ tests:
The `time_column` property points to the name of the column storing the timestamp
of each test-run. The data points will be ordered by that column.

The `metrics` property selects the columns tha hold the values to be analyzed. These values must
The `metrics` property selects the columns that hold the values to be analyzed. These values must
be numbers convertible to floats. The `metrics` property can be not only a simple list of column
names, but it can also be a dictionary configuring other properties of each metric,
the column name or direction:
Expand Down
10 changes: 10 additions & 0 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,13 @@ To build the Docker container, run the following command:
```bash
docker build -t otava .
```

> [!NOTE]
> The Dockerfile contains a `--mount` option that requires BuildKit [^1].
> The BuildKit can be installed with the following commands:
>
> Debian and Ubuntu: `apt install -y docker-buildx`
>
> Fedora: `dnf install docker-buildx`
>
> [^1]: https://docs.docker.com/go/buildkit/
Copy link
Contributor

@henrikingo henrikingo Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aplogies, I'm following a bit from a distance these past weeks... But wasn't this docker issue resolved by using python ?

Copy link
Contributor Author

@ligurio ligurio Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

otava's installation guide suggest two ways: installation via pipx and installation to the docker container. It is two independent ways of installation. The second way is failed without BuildKit.

Copy link
Contributor

@henrikingo henrikingo Apr 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah ok, in tox.ini we also explicitly use docker buildx

2 changes: 1 addition & 1 deletion docs/POSTGRESQL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ See [otava.yaml](../examples/postgresql/otava.yaml) for the example configuratio

[schema.sql](../examples/postgresql/init-db/schema.sql) contains the schema used in this example.

[docker-compose.yaml](../examples/postgresql/docker-compose.yaml) contains example config required to connect to PosgreSQL:
[docker-compose.yaml](../examples/postgresql/docker-compose.yaml) contains example config required to connect to PostgreSQL:
1. `POSTGRES_*` environment variables are used to pass connection details to the container.
2. `OTAVA_CONFIG` is the path to the configuration file described above.
3. `BRANCH` variable is used within `OTAVA_CONFIG` to analyze experiment results only for a specific branch.
Expand Down