forked from clan/clan-core
documentation: improve presentation
This commit is contained in:
parent
ca0c109b76
commit
2d42af3675
@ -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:
|
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<!-- [docs/site/index.md](docs/site/index.md) --> 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)<!-- [docs/site/index.md](docs/site/index.md) --> to get up and running with cLAN in no time.
|
||||||
|
|
||||||
### Managing Secrets
|
### Managing Secrets
|
||||||
|
|
||||||
In the Clan ecosystem, security is paramount. Learn how to handle secrets effectively:
|
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.md](docs/site/getting-started/secrets.md) -->.
|
- **Secrets Management**: Securely manage secrets by consulting [secrets](https://docs.clan.lol/getting-started/secrets/)<!-- [secrets.md](docs/site/getting-started/secrets.md) -->.
|
||||||
|
|
||||||
### Contributing to cLAN
|
### Contributing to cLAN
|
||||||
|
|
||||||
The Clan project thrives on community contributions. We welcome everyone to contribute and collaborate:
|
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/<!-- [contributing.md](docs/CONTRIBUTING.md) -->.
|
- **Contribution Guidelines**: Make a meaningful impact by following the steps in [contributing](https://docs.clan.lol/contributing/contributing/)<!-- [contributing.md](docs/CONTRIBUTING.md) -->.
|
||||||
|
|
||||||
## Join the Revolution
|
## Join the Revolution
|
||||||
|
|
||||||
|
@ -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
|
% 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.
|
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,
|
Since our clan secret module will auto-import secrets that are encrypted for a particular nixos machine,
|
||||||
|
Loading…
Reference in New Issue
Block a user