diff --git a/nix/README.md b/nix/README.md index b09fc6c9f7..f3ecee6a51 100644 --- a/nix/README.md +++ b/nix/README.md @@ -91,7 +91,7 @@ Some additional modules like `memory`, `docker` and `release` have large dependencies that would need to be built before the shell becomes available, which could take an especially long time if the cachix binary cache is not used. You can activate those by passing a flag to `nix-shell` with -`nix-shell --arg true`. This will make the respective utilites available: +`nix-shell --arg true`. This will make the respective utilities available: ```bash $ nix-shell --arg memory true @@ -113,7 +113,7 @@ postgrest-test-memory Note that `postgrest-test-memory` is now also available. To run one-off commands, you can also use `nix-shell --run `, which -will lauch the Nix shell, run that one command and exit. Note that the tab +will launch the Nix shell, run that one command and exit. Note that the tab completion will not work with `nix-shell --run`, as Nix has yet to evaluate our Nix expressions to see which utilities are available. @@ -246,7 +246,7 @@ $ nix-shell --run postgrest-style ``` There is also `postgrest-style-check` that exits with a non-zero exit code if -the check resulted in any uncommited changes. It's mostly useful for CI. +the check resulted in any uncommitted changes. It's mostly useful for CI. ## General development tools @@ -309,7 +309,7 @@ version. ### `shell.nix` [`shell.nix`](../shell.nix) defines an environment in which PostgREST can be -built and developed. It extends the build enviroment from our `postgrest` +built and developed. It extends the build environment from our `postgrest` attribute with useful utilities that will be put on the PATH in `nix-shell`. ### `nix/overlays` diff --git a/nix/UPGRADE.md b/nix/UPGRADE.md index 99be8228e3..5fd6d68a23 100644 --- a/nix/UPGRADE.md +++ b/nix/UPGRADE.md @@ -74,7 +74,7 @@ required to avoid build timeouts in CI. You'll need to set the `CACHIX_SIGNING_KEY` before proceeding, e.g. by creating a file containing `export CACHIX_SIGNING_KEY=...` and sourcing that file, which -avoids having the secret in you shell history. +avoids having the secret in your shell history. To push all new artifacts to Cachix, run: diff --git a/nix/tools/release/docker-hub-full-description.md b/nix/tools/release/docker-hub-full-description.md index 03f0c83388..76a6481831 100644 --- a/nix/tools/release/docker-hub-full-description.md +++ b/nix/tools/release/docker-hub-full-description.md @@ -48,13 +48,13 @@ To learn how to use this container, see the [PostgREST Docker documentation](https://postgrest.org/en/stable/install.html#docker). You can configure the PostgREST image by setting -[enviroment variables](https://postgrest.org/en/stable/configuration.html). +[environment variables](https://postgrest.org/en/stable/configuration.html). # How this image is built The image is built from scratch using [Nix](https://nixos.org/nixpkgs/manual/#sec-pkgs-dockerTools) instead of a -`Dockerfile`, which yields a higly secure and optimized image. This is also why +`Dockerfile`, which yields a highly secure and optimized image. This is also why no commands are listed in the image history. See the [PostgREST respository](https://github.com/PostgREST/postgrest/tree/main/nix/tools/docker) for details on the build process and how to inspect the image.