From fe0525f4ee01a5addc2abf2b88cd7a0c2a82da4f Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 21 Nov 2023 16:58:53 +0100 Subject: [PATCH 1/3] docs: add reference to "hack" in installation guide --- docs/abra/install.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/abra/install.md b/docs/abra/install.md index d9b280af..0dbdf0ba 100644 --- a/docs/abra/install.md +++ b/docs/abra/install.md @@ -18,6 +18,10 @@ curl https://install.abra.coopcloud.tech | bash curl https://install.abra.coopcloud.tech | bash -s -- --rc ``` +## Compile from source + +Follow the guide [here](https://docs.coopcloud.tech/abra/hack/) + ## Installer script source You can view that [here](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer). From a6b7b6fb86a6890e2e7c2ca8a890986fccd88afa Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 21 Nov 2023 16:58:53 +0100 Subject: [PATCH 2/3] docs: update make instructions with correct commands and further instructions --- docs/abra/hack.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/abra/hack.md b/docs/abra/hack.md index 3a308319..6d8ca802 100644 --- a/docs/abra/hack.md +++ b/docs/abra/hack.md @@ -10,10 +10,11 @@ Install [direnv](https://direnv.net), run `cp .envrc.sample .envrc`, then run `d Install [Go >= 1.16](https://golang.org/doc/install) and then: -- `make build` to build +- `make build` to build. If this fails, run `go mod tidy`. - `./abra` to run commands - `make test` will run tests -- `make install` will install it to `$GOPATH/bin` +- `make install-abra` will install abra to `$GOPATH/bin` +- `make install-kadabra` will install kadabra to `$GOPATH/bin` - `go get ` and `go mod tidy` to add a new dependency Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/.drone.yml) runs a number of checks on each pushed commit. See the [Makefile](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/Makefile) for more handy targets. From 34185e36ce445818de49fe3037531fc7d00e759e Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 21 Nov 2023 16:58:53 +0100 Subject: [PATCH 3/3] docs: add context to wsl installation warning --- docs/abra/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/abra/install.md b/docs/abra/install.md index 0dbdf0ba..52741bdf 100644 --- a/docs/abra/install.md +++ b/docs/abra/install.md @@ -4,7 +4,7 @@ title: Install !!! warning - We've seen reports that `abra` under [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) doesn't work due to an underlying bug in Docker context handling. See [`coop-cloud/organising#406`](https://git.coopcloud.tech/coop-cloud/organising/issues/406) and [`docker/for-win#13180`](https://github.com/docker/for-win/issues/13180) for more. + 02/2023: We've seen reports that `abra` under [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) doesn't work due to an underlying bug in Docker context handling. See [`coop-cloud/organising#406`](https://git.coopcloud.tech/coop-cloud/organising/issues/406) and [`docker/for-win#13180`](https://github.com/docker/for-win/issues/13180) for more. However, this might be fixed with newer versions of Docker. ## Stable release