From 2d42af36752a41347501b6c82d2a263db7188c64 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Mon, 15 Apr 2024 11:51:56 +0200 Subject: [PATCH] documentation: improve presentation --- README.md | 6 +++--- docs/site/getting-started/secrets.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22e0d86b..6515a226 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,19 @@ Our mission is simple: to democratize computing by providing tools that empower If you're new to cLAN and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers: -- **Quickstart Guide**: Check out https://docs.clan.lol/#starting-with-a-new-clan-project to get up and running with cLAN in no time. +- **Quickstart Guide**: Check out [getting started](https://docs.clan.lol/#starting-with-a-new-clan-project) to get up and running with cLAN in no time. ### Managing Secrets In the Clan ecosystem, security is paramount. Learn how to handle secrets effectively: -- **Secrets Management**: Securely manage secrets by consulting https://docs.clan.lol/getting-started/secrets/. +- **Secrets Management**: Securely manage secrets by consulting [secrets](https://docs.clan.lol/getting-started/secrets/). ### Contributing to cLAN The Clan project thrives on community contributions. We welcome everyone to contribute and collaborate: -- **Contribution Guidelines**: Make a meaningful impact by following the steps in https://docs.clan.lol/contributing/contributing/. +- **Contribution Guidelines**: Make a meaningful impact by following the steps in [contributing](https://docs.clan.lol/contributing/contributing/). ## Join the Revolution diff --git a/docs/site/getting-started/secrets.md b/docs/site/getting-started/secrets.md index caaf36c9..e01a41d1 100644 --- a/docs/site/getting-started/secrets.md +++ b/docs/site/getting-started/secrets.md @@ -189,7 +189,7 @@ If you already happened to use sops-nix, you can migrate by using the `clan secr % clan secrets import-sops --prefix matchbox- --group admins --machine matchbox nixos/matchbox/secrets/secrets.yaml ``` -This will create secrets for each secret found in `nixos/matchbox/secrets/secrets.yaml` in a ./sops folder of your repository. +This will create secrets for each secret found in `nixos/matchbox/secrets/secrets.yaml` in a `./sops` folder of your repository. Each member of the group `admins` in this case will be able to decrypt the secrets with their respective key. Since our clan secret module will auto-import secrets that are encrypted for a particular nixos machine,