update documentation

hacl-bot · Aug 6, 2024 · 2c56070 · 2c56070
1 parent 107936a
commit 2c56070
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 11 deletions.
diff --git a/doc/src/access.md b/doc/src/access.md
@@ -1,6 +1,6 @@
 # Access
 
-To give `sudo` access to `everest-ci` to someone, add the person's ssh key to
+To give `sudo` access to the machine to someone, add the person's ssh key to
 `./keys.nix` in the hacl-ci repository. Then re-encrypt the secrets for that
 key.
 

diff --git a/doc/src/maintenance.md b/doc/src/maintenance.md
@@ -1,6 +1,6 @@
 # Maintenance
 
-`everest-ci` runs NixOS. The system configuration is contained in the flake
+The CI machine runs NixOS. The system configuration is contained in the flake
 [github:hacl-bot/hacl-ci](https://github.com/hacl-bot/hacl-ci). Deployment of
 the configuration is acheived from Inria's local network or through the VPN by
 running the `switch.sh` script.

diff --git a/doc/src/overview.md b/doc/src/overview.md
@@ -1,9 +1,6 @@
 # Overview
 
-The main machine used for CI is
-[everest-ci.paris.inria.fr](https://everest-ci.paris.inria.fr/).
-
-`everest-ci` runs on NixOS and is home to self-hosted GitHub runners. It is
+The CI machine runs on NixOS and is home to self-hosted GitHub runners. It is
 mainly used by HACL*. To mitigate threats caused by the use of a self-hosted
 runner on public repositories, we require approval to run workfows on pull
 requests from first time contributors.
@@ -16,8 +13,8 @@ build time and retrieves the most recent versions of F* and Karamel.
 flake with a lock file, which is updated daily (if hacl builds). It can be used
 to retrieve the most recent working set of dependencies for HACL*.
 
-[hacl-ci](https://github.com/hacl-bot/hacl-ci) holds the NixOS configuration
-for `everest-ci`, as well as the source code for this documentation. All
+[hacl-ci](https://github.com/hacl-bot/hacl-ci) holds the NixOS configuration for
+the machine, as well as the source code for this documentation. All
 modifications to the configuration of the self-hosted runners should be done
 through this repository and deployed using the `switch.sh` script.
 [agenix](https://github.com/ryantm/agenix) is used to store secrets in the

diff --git a/doc/src/troubleshooting.md b/doc/src/troubleshooting.md
@@ -1,10 +1,10 @@
 # Troubleshooting
 
-Once your ssh key has been added to the `everest-ci` config, you can access the
-machine from Inria's internal network or through Inria's VPN:
+Once your ssh key has been added to the NixOS config, you can access the machine
+from Inria's internal network or through Inria's VPN:
 
 ```bash
-ssh [email protected]
+ssh [email protected]
 ```
 
 You can inspect the GitHub runners: