From ced993b0b74f2bebe79b655a0e242eac5acf21aa Mon Sep 17 00:00:00 2001 From: Nico Jensch Date: Tue, 17 Oct 2023 10:53:39 +0200 Subject: [PATCH] docs: updates concerning website deployment --- docs/src/common.md | 7 +++---- docs/src/general.md | 1 + 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/common.md b/docs/src/common.md index e9e6f15..f272b74 100644 --- a/docs/src/common.md +++ b/docs/src/common.md @@ -128,17 +128,16 @@ systemctl status borgbackup-job-backupToHetzner This should yield a successful unit state. The only exception is having an exit code != `0` due to files having changed during the run. -### Updating the website content or Chaotic-AUR toolbox +### Updating Chaotic-AUR toolbox -This needs to be done by updating the flake input (git repo URL of the website) [src-garuda-website](https://gitlab.com/garuda-linux/infra-nix/-/blob/main/nix/flake.nix?ref_type=heads#L60) or [src-chaotic-toolbox](https://gitlab.com/garuda-linux/infra-nix/-/blob/main/nix/flake.nix?ref_type=heads#L44): +This needs to be done by updating the flake input (git repo URL of the website) [src-chaotic-toolbox](https://gitlab.com/garuda-linux/infra-nix/-/blob/main/nix/flake.nix?ref_type=heads#L44): ```sh cd nix -nix flake lock --update-input src-garuda-website # website nix flake lock --update-input src-chaotic-toolbox # toolbox ``` -After that deploy as usual by running `deploy` and `apply`. The commit and corresponding hash will be updated and NixOS will use it to build the website or toolbox using the new revision automatically. +After that deploy as usual by running `deploy` and `apply`. The commit and corresponding hash will be updated and NixOS will use it to build the toolbox using the new revision automatically. ### Updating the Garuda startpage content diff --git a/docs/src/general.md b/docs/src/general.md index 292fdd6..6916199 100644 --- a/docs/src/general.md +++ b/docs/src/general.md @@ -89,6 +89,7 @@ We have used pull-/push-based mirroring for this git repository, which allows ea - `nix flake check` runs for every labeled PR and commit on main. - [Renovate](https://renovatebot.com/) periodically checks `docker-compose.yml` and other supported files for version updates. It has a [dependency dashboard](https://github.com/garuda-linux/infrastructure-nix/issues/5) as well as the [developer interface](https://developer.mend.io/github/garuda-linux/infrastructure-nix) to check logs of individual runs. Minor updates appear as grouped PRs while major updates are separated from those. Note that this only applies to the GitHub side. - Deployment of our [mdBook-based](https://github.com/rust-lang/mdBook) documentation to Cloudflare pages. +- Deployment of our Website to Cloudflare pages. Workflows will generally only be executed if a relevant file has been changed, eg. `nix flake check` won't run if only the README was changed.