From f1933768fcb718f908db0154a4b17b7a6d4ca1a3 Mon Sep 17 00:00:00 2001 From: 3wc <3wc@doesthisthing.work> Date: Sun, 9 Apr 2023 10:15:44 -0400 Subject: [PATCH] Fix broken links, tweak language --- docs/abra/hack.md | 6 +++--- docs/glossary/index.md | 22 +++++++++++----------- docs/intro/faq.md | 4 ++-- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/abra/hack.md b/docs/abra/hack.md index db9e9c8..71a5509 100644 --- a/docs/abra/hack.md +++ b/docs/abra/hack.md @@ -16,7 +16,7 @@ Install [Go >= 1.16](https://golang.org/doc/install) and then: - `make install` will install it 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 sanity on each pushed commit. See the [Makefile](./Makefile) for more handy targets. +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. Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log. @@ -38,7 +38,7 @@ For developers, while using this `-beta` format, the `y` part is the "major" ver ### Making a new release -- Change `ABRA_VERSION` to match the new tag in [`scripts`](./scripts/installer/installer) (use [semver](https://semver.org)) +- Change `ABRA_VERSION` in [`scripts/installer/installer`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/scripts/installer/installer) to match the new tag (use [semver](https://semver.org)) - Commit that change (e.g. `git commit -m 'chore: publish next tag x.y.z-beta'`) - Make a new tag (e.g. `git tag -a x.y.z-beta`) - Push the new tag (e.g. `git push && git push --tags`) @@ -54,7 +54,7 @@ We maintain a fork of [godotenv](https://github.com/Autonomic-Cooperative/godote ### `docker/client` -A number of modules in [pkg/upstream](./pkg/upstream) are copy/pasta'd from the upstream [docker/docker/client](https://pkg.go.dev/github.com/docker/docker/client). We had to do this because upstream are not exposing their API as public. +A number of modules in [pkg/upstream](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/pkg/upstream) are copy/pasta'd from the upstream [docker/docker/client](https://pkg.go.dev/github.com/docker/docker/client). We had to do this because upstream are not exposing their API as public. ### `github.com/schultz-is/passgen` diff --git a/docs/glossary/index.md b/docs/glossary/index.md index e3d0d58..95a0022 100644 --- a/docs/glossary/index.md +++ b/docs/glossary/index.md @@ -12,11 +12,11 @@ An app is a libre software that you use, e.g. Wordpress, Gitea, Jitsi, Nextcloud ## Container -A [Docker](/glossary#docker) term: a running instance of an [image](/glossary#image), running processes that are isolated from the host system. +A [Docker](#docker) term: a running instance of an [image](#image), running processes that are isolated from the host system. ## Deployment -When you run `abra app deploy `, `abra` reads a [recipe](/glossary#recipe) configuration and creates an [app](/glossary#app). +When you run `abra app deploy `, `abra` reads a [recipe](#recipe) configuration and creates an [app](#app). ## Docker @@ -24,36 +24,36 @@ When you run `abra app deploy `, `abra` reads a [recipe](/glossary#recip ## Environment variables -Variables passed from the shell to processes invoked by it. They are used for configuring [services](/glossary#service). +Variables passed from the shell to processes invoked by it. They are used for configuring [services](#service). ## Environment file -A file contained in a [recipe](/glossary#recipe) describing the contents of [environmental variables](/glossary#environment-variables). +A file contained in a [recipe](#recipe) describing the contents of [environmental variables](#environment-variables). ## Image -A [Docker](/glossary#docker) term: a template for creating [containers](/glossary#container), describing their file structure and installed binaries. +A [Docker](#docker) term: a template for creating [containers](#container), describing their file structure and installed binaries. ## Proxy network -A [Docker](glossary#docker) related concept: a virtual network created on the server machine used for communicating between [services](/glossary#service). Any [service](/glossary#service) can be plugged into more than one [network](/glossary#network), allowing for control over data sharing between them. +A [Docker](#docker) related concept: a virtual network created on the server machine used for communicating between [services](#service). Any [service](#service) can be plugged into more than one [network](#network), allowing for control over data sharing between them. ## Recipe -A recipe is what we call the configuration files that are used to deploy an [app](/glossary#app). When you run `abra app deploy `, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuration commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud). +A recipe is what we call the configuration files that are used to deploy an [app](#app). When you run `abra app deploy `, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuration commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud). ## Secret -A [Docker](/glossary#docker) related concept: A way to store passwords encrypted on disk and mounted inside the [containers](/glossary#container) as files that can be read that contain the secret. See the [Docker secrets documentation for more](https://docs.docker.com/engine/swarm/secrets/). `abra` makes use of this approach to store secrets for deployed [apps](/glossary#app). +A [Docker](#docker) related concept: A way to store passwords encrypted on disk and mounted inside the [containers](#container) as files that can be read that contain the secret. See the [Docker secrets documentation for more](https://docs.docker.com/engine/swarm/secrets/). `abra` makes use of this approach to store secrets for deployed [apps](#app). ## Service -A [Docker](glossary#docker) term: a single [container](/glossary#container) that is a part of a [stack](glossary#stack). +A [Docker](#docker) term: a single [container](#container) that is a part of a [stack](#stack). ## Stack -A [Docker](glossary#docker) term: one or more [services](/glossary#service) running together to provide a functionality. +A [Docker](#docker) term: one or more [services](#service) running together to provide a functionality. ## Volume -A [Docker](/glossary#docker) term: a directory that can be mounted inside a [container](/glossary#container) to store data. Because [containers](/glossary#container) are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes. +A [Docker](#docker) term: a directory that can be mounted inside a [container](#container) to store data. Because [containers](#container) are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes. diff --git a/docs/intro/faq.md b/docs/intro/faq.md index 0cca525..eea6a4b 100644 --- a/docs/intro/faq.md +++ b/docs/intro/faq.md @@ -34,7 +34,7 @@ The project was started by workers at [Autonomic](https://autonomic.zone/) which Please read our [initial project announcement post](https://autonomic.zone/blog/co-op-cloud/) for more on this. -Also see our [strategy page](/strategy/). +Also see our [strategy page](../strategy/). ## How do I make a recipe for (package) an app? @@ -182,7 +182,7 @@ These are organisational concerns that Co-op Cloud can't solve for you which any ## What is important to consider when running containers in production? -The Co-op Cloud uses [containers](/faq/#why-containers) as a fundamental building block. Therefore it is important to be aware of some general principles for container management in production environments. These are typically things that you will want to discuss within your co-op or democratic collective about how to prioritise and build up process for. +The Co-op Cloud uses [containers](#why-containers) as a fundamental building block. Therefore it is important to be aware of some general principles for container management in production environments. These are typically things that you will want to discuss within your co-op or democratic collective about how to prioritise and build up process for. However, as the Co-op Cloud project is still very young, we're also still thinking about how we can make the platform itself mitigate problematic issues and make the maintenance of containers a more stable experience.