From b95e6d326221892d71be8a7a256ac622ced0d2a3 Mon Sep 17 00:00:00 2001 From: nrdxp Date: Mon, 15 Feb 2021 00:36:17 +0000 Subject: [PATCH] deploy: 099de95610b2b2a3f7e60b287abaea2dbe44f288 --- 404.html | 2 +- cachix/index.html | 2 +- doc/flk/get.html | 241 +++++++++++++++++++++++++ doc/flk/home.html | 241 +++++++++++++++++++++++++ doc/flk/index.html | 26 ++- doc/flk/install.html | 243 ++++++++++++++++++++++++++ doc/flk/iso.html | 242 +++++++++++++++++++++++++ doc/flk/up.html | 238 +++++++++++++++++++++++++ doc/flk/update.html | 239 +++++++++++++++++++++++++ doc/{introduction.html => index.html} | 68 +++---- doc/layout.html | 2 +- doc/start/from-nixos.html | 2 +- doc/start/index.html | 6 +- doc/start/iso.html | 2 +- extern/index.html | 2 +- highlight.js | 4 +- hosts/index.html | 4 +- index.html | 19 +- modules/index.html | 2 +- overlays/index.html | 2 +- overrides/index.html | 2 +- pkgs/index.html | 2 +- print.html | 101 ++++++++++- profiles/index.html | 2 +- searchindex.js | 2 +- searchindex.json | 2 +- secrets/index.html | 2 +- suites/index.html | 2 +- theme/highlight.js | 6 + users/index.html | 2 +- 30 files changed, 1644 insertions(+), 66 deletions(-) create mode 100644 doc/flk/get.html create mode 100644 doc/flk/home.html create mode 100644 doc/flk/install.html create mode 100644 doc/flk/iso.html create mode 100644 doc/flk/up.html create mode 100644 doc/flk/update.html rename doc/{introduction.html => index.html} (63%) create mode 100644 theme/highlight.js diff --git a/404.html b/404.html index 9c884dc..88793be 100644 --- a/404.html +++ b/404.html @@ -97,7 +97,7 @@ diff --git a/cachix/index.html b/cachix/index.html index 566dc3b..8b3fdc1 100644 --- a/cachix/index.html +++ b/cachix/index.html @@ -95,7 +95,7 @@ diff --git a/doc/flk/get.html b/doc/flk/get.html new file mode 100644 index 0000000..304d3ea --- /dev/null +++ b/doc/flk/get.html @@ -0,0 +1,241 @@ + + + + + + get - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

get

+

The get subcommand is useful for getting a bare copy of nixflk without the +git history. You can pull either the core or community branches.

+

Usage

+
flk get BRANCH DEST-DIR
+
+

If DEST-DIR is ommitted, it defaults to ./flk.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/flk/home.html b/doc/flk/home.html new file mode 100644 index 0000000..252db04 --- /dev/null +++ b/doc/flk/home.html @@ -0,0 +1,241 @@ + + + + + + home - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

home

+

The home subcommand is for using your home-manager configurations outside of +NixOS, providing an awesome mechanism for keeping your environments +synchronized, even when using other systems.

+

Usage

+

The users page contains a good usage +example.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/flk/index.html b/doc/flk/index.html index 6f84288..ffee6a3 100644 --- a/doc/flk/index.html +++ b/doc/flk/index.html @@ -3,7 +3,7 @@ - flk command - nixflk docs + flk - nixflk docs @@ -95,7 +95,7 @@ @@ -164,6 +164,20 @@

flk command

+

The devshell for the project incudes a convenient script for managing your +system called flk. Each of the following chapters is a reference for one of +its subcommands.

+

Rebuild

+

Without any of the subcommands, flk acts as a convenient shortcut for +nixos-rebuild:

+
flk NixOS build
+
+

Will build hosts/NixOS.nix. You can change out build for switch, test, +etc. Any additional arguments are passed through to the call to +nixos-rebuild.

+

Usage

+
flk help
+
@@ -176,6 +190,10 @@ + +
@@ -190,6 +208,10 @@ + +
diff --git a/doc/flk/install.html b/doc/flk/install.html new file mode 100644 index 0000000..b620c8f --- /dev/null +++ b/doc/flk/install.html @@ -0,0 +1,243 @@ + + + + + + install - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

install

+

The install subcommand is a simple convenience for nixos-install, similar +to the shortcut for nixos-rebuild, all additional arguments are passed +through.

+

Example

+
flk install NixOS
+
+

This will install hosts/NixOS.nix to /mnt. You can override this directory +using standard nixos-install args.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/flk/iso.html b/doc/flk/iso.html new file mode 100644 index 0000000..99a8397 --- /dev/null +++ b/doc/flk/iso.html @@ -0,0 +1,242 @@ + + + + + + iso - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

ISO

+

Making and writing an installable iso for hosts/NixOS.nix is as simple as:

+
flk iso NixOS
+
+dd bs=4M if=result/iso/*.iso of=/dev/$your_installation_device \
+  status=progress oflag=sync
+
+

This works for any file matching hosts/*.nix excluding default.nix.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/flk/up.html b/doc/flk/up.html new file mode 100644 index 0000000..c339c25 --- /dev/null +++ b/doc/flk/up.html @@ -0,0 +1,238 @@ + + + + + + up - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

up

+

The up subcommand is a simple shortcut for nixos-generate-config that is +compatible with nixflk. There is a short explanation in the the getting started +guide.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/flk/update.html b/doc/flk/update.html new file mode 100644 index 0000000..ebe5980 --- /dev/null +++ b/doc/flk/update.html @@ -0,0 +1,239 @@ + + + + + + update - nixflk docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+

update

+

The update subcommand is a simple alias for:

+
nix flake update --recreate-lock-file --commit-lock-file
+
+

As it sounds, this will update your lock file, and commit it.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/introduction.html b/doc/index.html similarity index 63% rename from doc/introduction.html rename to doc/index.html index 558728e..9b3b127 100644 --- a/doc/introduction.html +++ b/doc/index.html @@ -3,7 +3,7 @@ - Introduction - nixflk docs + Contributing - nixflk docs @@ -95,7 +95,7 @@ @@ -163,41 +163,45 @@
-

Introduction

-

Nixflk is a template which grants a simple way to use, deploy and manage -NixOS systems for personal and productive use. It does this by -providing a sane repository structure, integrating several popular projects -like home-manager, setting clear guidelines, offering useful -conveniences, and eliminating boilerplate so you can focus on deploying your -systems.

-

Community Profiles

-

There are two branches from which to choose: core and -community. The community branch builds on core and includes -several ready-made profiles for discretionary use.

-

Every package and NixOS profile declared in community is uploaded to -cachix, so everything provided is available without building -anything. This is especially useful for the packages that are -overridden from master, as without the cache, rebuilds are -quite frequent.

-

⚠ Advisory

-

Nixflk leverages the flakes feature available via an experimental -branch of nix. Until nix 3.0 is released, this project should be -considered unstable.

-

License

-

Nixflk is licensed under the MIT License.

+

Pull Requests

+

If making a change to core, or adding a feature, please be sure to update the +relevant docs. Each directory contains its own README.md, which will +automatically be pulled into the mdbook. The book is +rendered on every change, so the docs should always be up to date.

+

Community PRs

+

While much of your work in this template may be idiosyncratic in nature. Anything +that might be generally useful to the broader NixOS community can be synced to +the community branch to provide a host of useful NixOS configurations available +"out of the box".

+

Style

+

If you wish to contribute please follow these guidelines:

+
    +
  • +

    format your code with nixpkgs-fmt. The default devshell +includes a pre-commit hook that does this for you.

    +
    • +
  • +

    The commit message follows the same semantics as nixpkgs.

    +
      +
    • You can use a # symbol to specify ambiguities. For example, +develop#zsh: <rest of commit message> would tell me that your updating the +zsh subprofile living under the develop profile.
      • +
    +
    • +
@@ -205,12 +209,12 @@ considered unstable.

diff --git a/doc/layout.html b/doc/layout.html index 58b95c3..f1237dc 100644 --- a/doc/layout.html +++ b/doc/layout.html @@ -95,7 +95,7 @@ diff --git a/doc/start/from-nixos.html b/doc/start/from-nixos.html index 1b8d32e..c124256 100644 --- a/doc/start/from-nixos.html +++ b/doc/start/from-nixos.html @@ -95,7 +95,7 @@ diff --git a/doc/start/index.html b/doc/start/index.html index a0675bf..28d0327 100644 --- a/doc/start/index.html +++ b/doc/start/index.html @@ -95,7 +95,7 @@ @@ -204,7 +204,7 @@ files before building the system.