Docs: move 'getting-started' into guides section
This commit is contained in:
@@ -24,7 +24,7 @@ If you're new to Clan and eager to dive in, start with our quickstart guide and
|
|||||||
|
|
||||||
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 [secrets](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/guides/getting-started/secrets/)<!-- [secrets.md](docs/site/guides/getting-started/secrets.md) -->.
|
||||||
|
|
||||||
### Contributing to Clan
|
### Contributing to Clan
|
||||||
|
|
||||||
|
|||||||
@@ -46,14 +46,14 @@ exclude_docs: |
|
|||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Getting Started:
|
|
||||||
- Setup Clan: getting-started/index.md
|
|
||||||
- Create Installer: getting-started/installer.md
|
|
||||||
- Add Machines: getting-started/configure.md
|
|
||||||
- Secrets & Facts: getting-started/secrets.md
|
|
||||||
- Deploy Machine: getting-started/deploy.md
|
|
||||||
- Continuous Integration: getting-started/check.md
|
|
||||||
- Guides:
|
- Guides:
|
||||||
|
- Getting Started:
|
||||||
|
- Setup Clan: guides/getting-started/index.md
|
||||||
|
- Create Installer: guides/getting-started/installer.md
|
||||||
|
- Add Machines: guides/getting-started/configure.md
|
||||||
|
- Secrets & Facts: guides/getting-started/secrets.md
|
||||||
|
- Deploy Machine: guides/getting-started/deploy.md
|
||||||
|
- Continuous Integration: guides/getting-started/check.md
|
||||||
- clanServices: guides/clanServices.md
|
- clanServices: guides/clanServices.md
|
||||||
- Disk Encryption: guides/disk-encryption.md
|
- Disk Encryption: guides/disk-encryption.md
|
||||||
- Mesh VPN: guides/mesh-vpn.md
|
- Mesh VPN: guides/mesh-vpn.md
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ Clan currently offers the following methods to configure machines:
|
|||||||
|
|
||||||
- machines/`machine_name`/configuration.nix (`autoincluded` if it exists)
|
- machines/`machine_name`/configuration.nix (`autoincluded` if it exists)
|
||||||
|
|
||||||
See the complete [list](../manual/adding-machines.md#automatic-registration) of auto-loaded files.
|
See the complete [list](../../manual/adding-machines.md#automatic-registration) of auto-loaded files.
|
||||||
|
|
||||||
???+ Note "Used by CLI & UI"
|
???+ Note "Used by CLI & UI"
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ In the `flake.nix` file:
|
|||||||
|
|
||||||
=== "**template using flake-parts**"
|
=== "**template using flake-parts**"
|
||||||
|
|
||||||
!!! info "See [Clan with flake-parts](../manual/flake-parts.md) for help migrating to flake-parts."
|
!!! info "See [Clan with flake-parts](../../manual/flake-parts.md) for help migrating to flake-parts."
|
||||||
|
|
||||||
```nix title="flake.nix" hl_lines="3"
|
```nix title="flake.nix" hl_lines="3"
|
||||||
clan = {
|
clan = {
|
||||||
@@ -45,7 +45,7 @@ Add the Clan CLI into your development workflow:
|
|||||||
nix shell git+https://git.clan.lol/clan/clan-core#clan-cli --refresh
|
nix shell git+https://git.clan.lol/clan/clan-core#clan-cli --refresh
|
||||||
```
|
```
|
||||||
|
|
||||||
You can find reference documentation for the `clan` cli program [here](../reference/cli/index.md).
|
You can find reference documentation for the `clan` cli program [here](../../reference/cli/index.md).
|
||||||
|
|
||||||
Alternatively you can check out the help pages directly:
|
Alternatively you can check out the help pages directly:
|
||||||
```terminalSession
|
```terminalSession
|
||||||
@@ -151,7 +151,7 @@ sudo umount /dev/sdb1
|
|||||||
|
|
||||||
|
|
||||||
### Step 3: Boot From USB Stick
|
### Step 3: Boot From USB Stick
|
||||||
- To use, boot from the Clan USB drive with **secure boot turned off**. For step by step instructions go to [Disabling Secure Boot](../manual/secure-boot.md)
|
- To use, boot from the Clan USB drive with **secure boot turned off**. For step by step instructions go to [Disabling Secure Boot](../../manual/secure-boot.md)
|
||||||
|
|
||||||
|
|
||||||
## (Optional) Connect to Wifi Manually
|
## (Optional) Connect to Wifi Manually
|
||||||
@@ -6,32 +6,7 @@ hide:
|
|||||||
|
|
||||||
# :material-home: Welcome to **Clan**'s documentation
|
# :material-home: Welcome to **Clan**'s documentation
|
||||||
|
|
||||||
[Getting Started](./getting-started/index.md){ .md-button }
|
[Getting Started](./guides/getting-started/index.md){ .md-button }
|
||||||
|
|
||||||
## Tutorials
|
|
||||||
|
|
||||||
**Learning-oriented adventures with a hands-on experience.**
|
|
||||||
|
|
||||||
<div class="grid cards" markdown>
|
|
||||||
|
|
||||||
- :material-clock-fast:{ .lg .middle } __Set up in 15 minutes__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Create your own clan and get everything
|
|
||||||
running in minutes
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: Getting started](./getting-started/index.md)
|
|
||||||
|
|
||||||
- :fontawesome-solid-user-group:{ .lg .middle } __Authoring Modules__
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Create ressources that can be reused by the community.
|
|
||||||
|
|
||||||
[:octicons-arrow-right-24: Authoring guides](./guides/authoring/clanModules/index.md)
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## :material-book: Guides
|
## :material-book: Guides
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ This guide will help you migrate your existing Nix configurations into Clan.
|
|||||||
|
|
||||||
!!! Warning
|
!!! Warning
|
||||||
Migrating instead of starting new can be trickier and might lead to bugs or
|
Migrating instead of starting new can be trickier and might lead to bugs or
|
||||||
unexpected issues. We recommend following the [Getting Started](../getting-started/index.md) guide first. Once you have a working setup, you can easily transfer your Nix configurations over.
|
unexpected issues. We recommend following the [Getting Started](../guides/getting-started/index.md) guide first. Once you have a working setup, you can easily transfer your Nix configurations over.
|
||||||
|
|
||||||
## Back up your existing configuration!
|
## Back up your existing configuration!
|
||||||
Before you start, it is strongly recommended to back up your existing
|
Before you start, it is strongly recommended to back up your existing
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ In this example, we will guide you through automating that interaction using cla
|
|||||||
For a more general explanation of what clan vars are and how it works, see the intro of the [Reference Documentation for vars](https://docs.clan.lol/reference/clan-core/vars/)
|
For a more general explanation of what clan vars are and how it works, see the intro of the [Reference Documentation for vars](https://docs.clan.lol/reference/clan-core/vars/)
|
||||||
|
|
||||||
This guide assumes
|
This guide assumes
|
||||||
- clan is set up already (see [Getting Started](../getting-started/index.md))
|
- clan is set up already (see [Getting Started](../guides/getting-started/index.md))
|
||||||
- a machine has been added to the clan (see [Adding Machines](./adding-machines.md))
|
- a machine has been added to the clan (see [Adding Machines](./adding-machines.md))
|
||||||
|
|
||||||
This section will walk you through the following steps:
|
This section will walk you through the following steps:
|
||||||
|
|||||||
0
reference/cli/index.md
Normal file
0
reference/cli/index.md
Normal file
Reference in New Issue
Block a user