Created a file about templates, created several starter files, added … #91
Conversation
…beginning of new section in install.md
| place pre-built flakes. For example, on another project, you might have | ||
| built a flake that configures mysql. In that project you placed it in |
There was a problem hiding this comment.
| place pre-built flakes. For example, on another project, you might have | |
| built a flake that configures mysql. In that project you placed it in | |
| place pre-built packages. For example, on another project, you might have | |
| built a package that configures mysql. In that project you placed it in |
Typically you would say "flake" to refer to the whole repository. And then package or "derivation" for those units of build.
There was a problem hiding this comment.
Thanks! I see this is still a draft, but nevertheless left some comments. Hope they are useful, feel free to ignore if not - might be a bit on the pedantic side 😅
nit: Line lengths seem to be quite inconsistent here. My personal preference would be to use explicit newlines for paragraphs only. Or use one line per sentence for improved diffs. Anything else is also fine, as long as it's consistent.
|
|
||
| Blueprint comes with several templates to help you get started with your project. | ||
|
|
||
| > Note: We are continuing to add additional templates. Please check back periodically. |
There was a problem hiding this comment.
Do we - as an ongoing effort? Maybe a call to action, such as "Let us know if you are missing one" or "You are welcome to contribute new one" could be useful here or at the end?
| > Note: We are continuing to add additional templates. Please check back periodically. | ||
|
|
||
| To install from a template, specify the template name after the initial flake init | ||
| command, preceded by a hash symbol. For example, to use the template called system |
There was a problem hiding this comment.
I think the order here is confusing, because this comes before the "initial flake init command" and the part about the hash symbol might be confusing without explicitly mentioning the URL. I think less could be more here, as the complete command follows right after :)
| Their respective configuration files both import a shared | ||
| `modules/nixos/host-shared.nix` module between them. | ||
|
|
||
| Also, both hosts define a `me` user and their home-managed configuration |
There was a problem hiding this comment.
| Also, both hosts define a `me` user and their home-managed configuration | |
| Also, both hosts define a `me` user and their home-manager configuration |
| Also, both hosts define a `me` user and their home-managed configuration | ||
| simply imports `modules/homes/home-shared.nix`. | ||
|
|
||
| Finally, notice in the root flake.nix we're adding the home-manager and nix-darwin |
There was a problem hiding this comment.
| Finally, notice in the root flake.nix we're adding the home-manager and nix-darwin | |
| Finally, notice in the root `flake.nix` we're adding the home-manager and nix-darwin |
| how to share configurations between different system and home environments on different hosts. | ||
|
|
||
|
|
||
| ## Toml-DevEnvs |
There was a problem hiding this comment.
Might not hurt to include it, but it's a comparatively niche use-case IMO, and I'd rather just link to devshells README as you do with system-manager below.
|
|
||
| > NOTE: It's better to use `perSystem` composition style instead of overlays if you can. | ||
|
|
||
| If set, blueprint will create a new instance of nixpkgs for each systems, with the passed config. |
There was a problem hiding this comment.
This is currently exactly the same as nixpkgs.config above. Is this by mistake or just an open TODO?
| @@ -69,6 +69,8 @@ Let's set up a development environment that includes: | |||
| * Python | |||
| * Python's numpy package | |||
|
|
|||
| > **TIP:** In this section we'll be creating a default developer environment. You can also set up multiple developer environments and place them in the devshell folder as shown in the devshell section [here](folder_structure.md). | |||
There was a problem hiding this comment.
nit: either use all caps for "tip" above or don't do here.
| > **TIP:** In this section we'll be creating a default developer environment. You can also set up multiple developer environments and place them in the devshell folder as shown in the devshell section [here](folder_structure.md). | |
| > **Tip:** In this section we'll be creating a default developer environment. You can also set up multiple developer environments and place them in the devshell folder as shown in the devshell section [here](folder_structure.md). |
| ``` | ||
|
|
||
| > Because Blueprint is present, this code will get located automatically. And notice | ||
| how it can be reused; indeed for this example, we simply copied it over from the |
There was a problem hiding this comment.
I think newslines break the quote here. Also probably intended a "Tip:" or something here?
| mike | ||
| mkdocs | ||
| mkdocs-material | ||
| mkdocs-awesome-pages-plugin |
There was a problem hiding this comment.
This was just renamed to mkdocs-awesome-nav in its newest release. (Landed in nixos-unstable just yesterday after NixOS/nixpkgs#389086 was merged and will therefore be in 25.05)
…beginning of new section in install.md