mirror of
https://github.com/divnix/digga.git
synced 2024-09-11 15:15:24 +03:00
spelling fixes
This commit is contained in:
parent
7e9b1c57ac
commit
62f5e48398
@ -10,7 +10,7 @@
|
||||
> maturing _well_ for a while.
|
||||
|
||||
|
||||
Digga — slangy german for "good friend" — is a flake utility library
|
||||
Digga — slangy German for "good friend" — is a flake utility library
|
||||
that helps you declaratively craft and manage all three layers of your system
|
||||
environment within a single [nix flakes][flakes] repository:
|
||||
|
||||
@ -27,12 +27,12 @@ You can also have a look at the different [examples][].
|
||||
|
||||
# Philosophy
|
||||
|
||||
In it's `lib.mkFlake` function, _digga_ implements a well-secified API
|
||||
In it's `lib.mkFlake` function, _Digga_ implements a well-specified API
|
||||
interface comprising four API containers that allow you to:
|
||||
|
||||
1. configure **nixpkgs channels** including internal and external overlays,
|
||||
|
||||
2. define **nixos hosts** including internal and external nixos modules as well as
|
||||
2. define **NixOS hosts** including internal and external NixOS modules as well as
|
||||
host defaults that apply to all hosts in the environment,
|
||||
|
||||
3. specify **user home environments** including internal and external home-manager
|
||||
@ -42,7 +42,7 @@ interface comprising four API containers that allow you to:
|
||||
your projects.
|
||||
|
||||
## Modules, Profiles & Suites
|
||||
For nixos- & home-manager-modules, _digga_ allows you to distinguish between
|
||||
For NixOS- & home-manager-modules, _Digga_ allows you to distinguish between
|
||||
_modules_, _profiles_ and _suites_.
|
||||
|
||||
- **Modules** are abstract configurations that, while holding the implementation, do not
|
||||
|
@ -1,7 +1,7 @@
|
||||
# TL;DR;
|
||||
- **Target Branch**: `main`
|
||||
- **Merge Policy**: [`bors`][bors] is alwyas right (→ `bors try`)
|
||||
- **Docs**: every changeset is expected to contain doc updates
|
||||
- **Merge Policy**: [`bors`][bors] is always right (→ `bors try`)
|
||||
- **Docs**: every change set is expected to contain doc updates
|
||||
- **Commit Msg**: be a poet! Comprehensive and explanatory commit messages
|
||||
should cover the motivation and use case in an easily understandable manner
|
||||
even when read after a few months.
|
||||
|
@ -5,6 +5,6 @@
|
||||
- [Channels](./api-reference-channels.md)
|
||||
- [Home](./api-reference-home.md)
|
||||
- [Devshell](./api-reference-devshell.md)
|
||||
- [Nixos](./api-reference-nixos.md)
|
||||
- [NixOS](./api-reference-nixos.md)
|
||||
- [Library Reference]()
|
||||
- [Contributing](./CONTRIBUTING.md)
|
||||
|
@ -3,7 +3,7 @@ Configure your devshell module collections of your environment.
|
||||
|
||||
|
||||
## devshell
|
||||
Modules to include in your devos shell. the `modules` argument
|
||||
Modules to include in your DevOS shell. the `modules` argument
|
||||
will be exported under the `devshellModules` output
|
||||
|
||||
|
||||
|
@ -136,7 +136,7 @@ HM users that can be deployed portably without a host.
|
||||
|
||||
|
||||
*_Type_*:
|
||||
attribute set of hm user configs
|
||||
attribute set of HM user configs
|
||||
|
||||
|
||||
*_Default_*
|
||||
|
@ -1,9 +1,9 @@
|
||||
# NixOS API Container
|
||||
Configure your nixos modules, profiles & suites.
|
||||
Configure your NixOS modules, profiles & suites.
|
||||
|
||||
|
||||
## nixos
|
||||
hosts, modules, suites, and profiles for nixos
|
||||
## NixOS
|
||||
hosts, modules, suites, and profiles for NixOS
|
||||
|
||||
|
||||
*_Type_*:
|
||||
@ -167,7 +167,7 @@ tests to run
|
||||
|
||||
|
||||
*_Type_*:
|
||||
list of valid nixos test or path convertible to its or anything convertible to it
|
||||
list of valid NixOS test or path convertible to its or anything convertible to it
|
||||
|
||||
|
||||
*_Default_*
|
||||
|
@ -1,10 +1,10 @@
|
||||
# Top Level API
|
||||
`digga`'s top level api. API Containers are documented in their respective subchapter:
|
||||
`digga`'s top level API. API Containers are documented in their respective sub-chapter:
|
||||
|
||||
- [Channels](./api-reference-channels.md)
|
||||
- [Home](./api-reference-home.md)
|
||||
- [Devshell](./api-reference-devshell.md)
|
||||
- [Nixos](./api-reference-nixos.md)
|
||||
- [NixOS](./api-reference-nixos.md)
|
||||
|
||||
## channelsConfig
|
||||
nixpkgs config for all channels
|
||||
@ -51,7 +51,7 @@ function that evaluates to a(n) attrs or path convertible to it
|
||||
|
||||
|
||||
## self
|
||||
The flake to create the devos outputs for
|
||||
The flake to create the DevOS outputs for
|
||||
|
||||
*_Type_*:
|
||||
nix flake
|
||||
|
@ -17,7 +17,7 @@ All your profiles defined in suites will be tested in a NixOS VM.
|
||||
You can write integration tests for one or more NixOS VMs that can,
|
||||
optionally, be networked together, and yes, it's as awesome as it sounds!
|
||||
|
||||
Be sure to use the `mkTest` function from digga, `digga.lib.pkgs-lib.mkTest`
|
||||
Be sure to use the `mkTest` function from Digga, `digga.lib.pkgs-lib.mkTest`
|
||||
which wraps the official [testing-python][testing-python] function to ensure
|
||||
that the system is setup exactly as it is for a bare DevOS system. There are
|
||||
already great resources for learning how to use these tests effectively,
|
||||
|
@ -396,7 +396,7 @@ in
|
||||
self = mkOption {
|
||||
type = flakeType;
|
||||
readOnly = true;
|
||||
description = "The flake to create the devos outputs for";
|
||||
description = "The flake to create the DevOS outputs for";
|
||||
};
|
||||
inputs = mkOption {
|
||||
type = inputsType;
|
||||
@ -451,7 +451,7 @@ in
|
||||
type = pathToOr devshellType;
|
||||
default = { };
|
||||
description = ''
|
||||
Modules to include in your devos shell. the `modules` argument
|
||||
Modules to include in your DevOS shell. the `modules` argument
|
||||
will be exported under the `devshellModules` output
|
||||
'';
|
||||
};
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Hey!
|
||||
|
||||
This project is commited to the [Unofficial Flakes Roadmap (ufr)](https://demo.hedgedoc.org/s/_W6Ve03GK#).
|
||||
This project is committed to the [Unofficial Flakes Roadmap (ufr)](https://demo.hedgedoc.org/s/_W6Ve03GK#).
|
||||
|
||||
|
||||
_The future of flakes is bright again._
|
||||
|
Loading…
Reference in New Issue
Block a user