Skip to content

Commit

Permalink
fix(docs): update version tags in examples (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
domire8 authored Mar 13, 2024
1 parent f2c1ebb commit 37c8c91
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions docs/docs/getting-started/03-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ only the base package. The version of the base package can be changed according
#syntax=ghcr.io/aica-technology/app-builder:v1

[packages]
"@aica/base" = "v3.0.0"
"@aica/base" = "v3.1.1"
```

### Configuring a runtime image with add-on packages
Expand All @@ -86,13 +86,13 @@ package.
#syntax=ghcr.io/aica-technology/app-builder:v1

[packages]
"@aica/base" = "v3.0.0"
"@aica/base" = "v3.1.1"

# add components
"@aica/components/signal-processing" = "v1.0.1"

# add hardware collections
"@aica/collections/ur-collection" = "v3.0.4"
"@aica/collections/ur-collection" = "v3.0.5"
```

### Including custom packages
Expand All @@ -108,7 +108,7 @@ docker registries such as DockerHub or GitHub Container Registry and can be incl
#syntax=ghcr.io/aica-technology/app-builder:v1

[packages]
"@aica/base" = "v3.0.0"
"@aica/base" = "v3.1.1"

# add a custom package from a local docker image path
"my-local-package" = "docker-image://my-custom-component-package"
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/05-examples/01-timer-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This example requires only the base image.
#syntax=ghcr.io/aica-technology/app-builder:v1

[packages]
"@aica/base" = "v3.0.0"
"@aica/base" = "v3.1.1"
```

## Setting up the application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This example requires the Universal Robots collection which includes example URD
#syntax=ghcr.io/aica-technology/app-builder:v1

[packages]
"@aica/base" = "v3.0.0"
"@aica/base" = "v3.1.1"

"@aica/collections/ur-collection" = "v3.0.4"
"@aica/collections/ur-collection" = "v3.0.5"
```

## URDF Hardware Manager
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/reference/custom-components/04-package-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A basic `aica-package.toml` file for a component package stored in the `custom_c
roughly like this:

```toml
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13

[build]
type = "ros"
Expand All @@ -23,10 +23,10 @@ type = "ros"
image = "iron"

[build.environment.aica.libraries]
"@aica/foss/control-libraries" = "v7.2.0"
"@aica/foss/control-libraries" = "v7.3.0"

[build.environment.aica.ros]
"@aica/foss/modulo" = "v3.2.0"
"@aica/foss/modulo" = "v4.0.0"

[build.packages.component]
source = "./custom_component_package"
Expand Down
24 changes: 12 additions & 12 deletions docs/docs/reference/custom-components/05-aica-package-toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Each `aica-package.toml` should start with `#syntax=ghcr.io/aica-technology/pack
the Docker syntax and version used to build the package.

```toml title="aica-package.toml"
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13
```

You can find the available
Expand Down Expand Up @@ -116,7 +116,7 @@ available yet.

```toml title="aica-package.toml"
[build.environment.aica.libraries]
"@aica/foss/control-libraries" = "v7.2.0"
"@aica/foss/control-libraries" = "v7.3.0"
"@aica/foss/network-interfaces" = "v2.0.1"
```

Expand All @@ -141,7 +141,7 @@ component built with a tag of `ghcr.io/myorg/mypackage:v1.0.0`, you could use it

```toml title="aica-package.toml"
[build.environment.aica.ros]
"@aica/foss/modulo" = "v3.2.0"
"@aica/foss/modulo" = "v4.0.0"
"@myorg/mypackage" = "docker-image://ghcr.io/myorg/mypackage:v1.0.0"
```

Expand Down Expand Up @@ -312,7 +312,7 @@ docker build -f aica-package.toml -t my_component .
```

```toml title="aica-package.toml"
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13

[build]
type = "ros"
Expand All @@ -321,10 +321,10 @@ type = "ros"
image = "iron"

[build.environment.aica.libraries]
"@aica/foss/control-libraries" = "v7.2.0"
"@aica/foss/control-libraries" = "v7.3.0"

[build.environment.aica.ros]
"@aica/foss/modulo" = "v3.2.0"
"@aica/foss/modulo" = "v4.0.0"

[build.packages.component]
source = "./custom_component_package"
Expand All @@ -339,7 +339,7 @@ docker build -f aica-package.toml -t my_component .
```

```toml title="aica-package.toml"
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13

[build]
type = "ros"
Expand All @@ -348,10 +348,10 @@ type = "ros"
image = "iron"

[build.environment.aica.libraries]
"@aica/foss/control-libraries" = "v7.2.0"
"@aica/foss/control-libraries" = "v7.3.0"

[build.environment.aica.ros]
"@aica/foss/modulo" = "v3.2.0"
"@aica/foss/modulo" = "v4.0.0"

[build.packages.component]
source = "./custom_component_package"
Expand All @@ -376,7 +376,7 @@ docker build -f aica-package.toml \
```

```toml title="aica-package.toml"
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13

[build]
type = "ros"
Expand All @@ -388,7 +388,7 @@ image = "docker-image://base"
"@aica/foss/control-libraries" = "build-context://cl"

[build.environment.aica.ros]
"@aica/foss/modulo" = "v3.2.0"
"@aica/foss/modulo" = "v4.0.0"

[build.packages.component]
source = "build-context://my_source"
Expand All @@ -401,7 +401,7 @@ docker build -f aica-package.toml -t my_component --target list .
```

```toml title="aica-package.toml"
#syntax=ghcr.io/aica-technology/package-builder:v0.0.9
#syntax=ghcr.io/aica-technology/package-builder:v0.0.13

[build]
type = "ros"
Expand Down

0 comments on commit 37c8c91

Please sign in to comment.