Skip to content

Commit

Permalink
restructure NixOS tutorials TOC (#1037)
Browse files Browse the repository at this point in the history
Co-authored-by: Valentin Gagarin <[email protected]>
  • Loading branch information
tfc and fricklerhandwerk authored Aug 26, 2024
1 parent 53dff23 commit 92f6419
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 10 deletions.
1 change: 1 addition & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@
/manual/nix /reference/nix-manual 200
/manual/nix/unstable/* https://hydra.nixos.org/job/nix/master/build.nix.x86_64-linux/latest/download/1/manual/:splat 200
/manual/nix/development/* https://hydra.nixos.org/job/nix/master/build.nix.x86_64-linux/latest/download/1/manual/:splat 200
/tutorials/nixos/continuous-integration-github-actions /guides/recipes/continuous-integration-github-actions 301
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ myst:

# Continuous integration with GitHub Actions

In this tutorial, we'll show you **a few short steps** to get started using [GitHub Actions](https://github.com/features/actions) as your continuous integration (CI) workflow for commits and pull requests.
In this guide, we'll show you **a few short steps** to get started using [GitHub Actions](https://github.com/features/actions) as your continuous integration (CI) workflow for commits and pull requests.

One benefit of Nix is that **CI can build and cache developer environments for every project** on every branch using binary caches.

Expand Down Expand Up @@ -109,4 +109,3 @@ jobs:

[magic-nix-cache]: https://github.com/DeterminateSystems/magic-nix-cache-action/
[github-actions-caching-limits]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows

1 change: 1 addition & 0 deletions source/guides/recipes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ sharing-dependencies.md
Managing remote sources <./dependency-management.md>
Python development environment <./python-environment.md>
post-build-hook.md
continuous-integration-github-actions.md
```
2 changes: 1 addition & 1 deletion source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The following list illustrates some of what can be achieved with the Nix ecosyst
- {ref}`Reproducible development environments <ad-hoc-envs>`.
- Easy installation of software over URLs.
- Easy transfer of software environments between computers.
- {ref}`Declarative specification of Linux machines <deploying-nixos-using-terraform>`.
- {ref}`Declarative specification of Linux machines <deploy-nixos-using-terraform>`.
- {ref}`Reproducible integration testing using virtual machines <integration-testing-vms>`.
- Avoidance of version conflicts with already installed software.
- Installing software from source code.
Expand Down
2 changes: 1 addition & 1 deletion source/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ nix-language.md
Packaging existing software <packaging-existing-software.md>
Package parameters and overrides <callpackage.md>
working-with-local-files.md
nixos/index.md
cross-compilation.md
module-system/index.md
nixos/index.md
```
3 changes: 1 addition & 2 deletions source/tutorials/nixos/deploying-nixos-using-terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ myst:
"keywords": "NixOS, deployment, Terraform, AWS"
---

(deploying-nixos-using-terraform)=

(deploy-nixos-using-terraform)=
# Deploying NixOS using Terraform

Assuming you're [familiar with the basics of Terraform](https://www.terraform.io/intro/index.html), by the end of this tutorial you will have provisioned an Amazon Web Services (AWS) instance with Terraform, and will be able to use Nix to deploy incremental changes to NixOS running on the instance.
Expand Down
24 changes: 20 additions & 4 deletions source/tutorials/nixos/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# NixOS

Learn how to configure, install, and deploy NixOS.
Learn how to configure, test, and install or deploy NixOS.

## Creating NixOS images

- [](nixos-configuration-on-vm)
- [](building-bootable-iso-image)
- [](building-and-running-docker-images)

## Integration testing

- [](integration-testing-using-virtual-machines)

## Deploying NixOS

- [](installing-nixos-on-a-raspberry-pi)
- [](deploying-nixos-using-terraform)


```{toctree}
:maxdepth: 1
:hidden: true
nixos-configuration-on-vm.md
integration-testing-using-virtual-machines.md
building-bootable-iso-image.md
installing-nixos-on-a-raspberry-pi.md
continuous-integration-github-actions.md
building-and-running-docker-images.md
integration-testing-using-virtual-machines.md
installing-nixos-on-a-raspberry-pi.md
deploying-nixos-using-terraform.md
```

0 comments on commit 92f6419

Please sign in to comment.