From 5c67848d6032eaf84b2167292f6784c96c2d196f Mon Sep 17 00:00:00 2001 From: Peter Baker Date: Fri, 6 Sep 2024 12:10:33 +1000 Subject: [PATCH] Removing nbsp and adding new liens Signed-off-by: Peter Baker --- .dockerignore | 2 +- .gitignore | 2 +- docs/src/development/docker.md | 22 +--------------------- 3 files changed, 3 insertions(+), 23 deletions(-) diff --git a/.dockerignore b/.dockerignore index 2deebaf7b..9fd3fc637 100644 --- a/.dockerignore +++ b/.dockerignore @@ -2,4 +2,4 @@ input/ output/ .git* assets/ -docs/ \ No newline at end of file +docs/ diff --git a/.gitignore b/.gitignore index 790bc0d9e..af531a8f8 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,4 @@ JuliaSysimage.dll docs/build/ input/ -output/ \ No newline at end of file +output/ diff --git a/docs/src/development/docker.md b/docs/src/development/docker.md index 6333f2c7a..39d6d21f0 100644 --- a/docs/src/development/docker.md +++ b/docs/src/development/docker.md @@ -79,8 +79,6 @@ You can also opt to specify some custom [build arguments](https://docs.docker.co See the [docker-compose.yaml](./docker-compose.yaml) file for an example of how to specify build arguments in docker compose. -  - ### Running `adria-base` with a non-interactive Julia command e.g. to list the packages installed in the `@adria` shared environment: @@ -93,8 +91,6 @@ docker compose run --rm adria-base --project=@adria -e 'using Pkg; Pkg.status()' docker run --rm ADRIA.jl/adria-base:latest --project=@adria -e 'using Pkg; Pkg.status()' ``` -  - ### Running `adria-base` as an interactive Julia shell To launch an interactive Julia shell: @@ -109,8 +105,6 @@ docker run --rm --interactive --tty ADRIA.jl/adria-base:latest In both cases, type `CTRL-d` to exit the shell and stop the container. -  - ### Running `adria-base` with a non-Julia entrypoint If you want to use this image to run something _other_ than a Julia command, you can specify an alternate entrypoint at runtime as well as an alternate command. e.g. to launch an interactive `bash` shell in the container for checking filesystem permissions or similar: @@ -123,8 +117,6 @@ docker compose run --rm --entrypoint /bin/bash adria-base docker run --rm --interactive --tty --entrypoint /bin/bash ADRIA.jl/adria-base:latest ``` -  - ### Deriving an image from `adria-base` To make a derived ADRIA application: @@ -134,8 +126,6 @@ To make a derived ADRIA application: The section of the [Dockerfile](./Dockerfile) that defines the `adria-sandbox` target described below might be useful inspiration. -  - --- ## adria-dev @@ -162,8 +152,6 @@ docker build --target "adria-dev" --tag ADRIA.jl/adria-dev:latest . The same `JULIA_VERSION` build argument that works with `adria-base` will also work with `adria-dev`. -  - ### Running `adria-dev` as an interactive Julia shell Very useful for running commands to update Package manifests and similar! @@ -182,8 +170,6 @@ docker run --rm --interactive --tty \ In both cases, type `CTRL-d` to exit the shell and stop the container. -  - --- ### Running ADRIA tests with `adria-dev` @@ -202,8 +188,6 @@ docker run --rm ADRIA.jl/adria-dev:latest --project=. -e 'using Pkg; Pkg.test(); This method of running tests is suitable to use in a containerised continuous integration pipeline. -  - --- ## adria-sandbox @@ -228,8 +212,6 @@ docker compose build adria-sandbox docker build --build-arg SANDBOX_FROM=adria-dev --target "adria-sandbox" --tag ADRIA.jl/adria-sandbox:latest . ``` -  - ### Running `adria-sandbox` The `adria-sandbox` image is configured to automatically run the `dev.jl` script when a container @@ -259,8 +241,6 @@ docker run --rm \ The `dev.jl` script should run with any files you have provided in your input volume, and will create and output files in your output volume. The container will be removed once the script completes. -  - ### Interacting with `adria-sandbox` If you prefer to work with the sandbox code from an interactive shell, then you will need to override the default entrypoint and command combination to make the container launch your preferred shell at startup. @@ -291,4 +271,4 @@ julia --project=@. dev.jl ``` **Warning:** For `julia` commands, you will probably need to use the `--project=@.` argument. This tells Julia that it's working environment is based in a parent directory of the one the sandbox source code is installed to, which is where the build -configured all the precompiled dependencies. If you omit this, the pre-installed packages may not all be available. \ No newline at end of file +configured all the precompiled dependencies. If you omit this, the pre-installed packages may not all be available.