diff --git a/source/glossary.md b/source/glossary.md new file mode 100644 index 0000000..ba6af62 --- /dev/null +++ b/source/glossary.md @@ -0,0 +1,14 @@ +# Glossary + +```{glossary} +attribute name + TODO + +package name + TODO + +reproducible + Reproducibility would guarantee exactly the same results no matter + **when** or **on what machine** you run the command. + +``` diff --git a/source/glossary.rst b/source/glossary.rst deleted file mode 100644 index 77d7fc5..0000000 --- a/source/glossary.rst +++ /dev/null @@ -1,14 +0,0 @@ -Glossary -======== - -.. glossary:: - - attribute name - TODO - - package name - TODO - - reproducible - Reproducibility would guarantee exactly the same results no matter - **when** or **on what machine** you run the command. \ No newline at end of file diff --git a/source/index.md b/source/index.md new file mode 100644 index 0000000..f530db7 --- /dev/null +++ b/source/index.md @@ -0,0 +1,45 @@ +--- +html_meta: + "description lang=en": "An opinionated guide for developers wanting to get things done with the Nix ecosystem." + "keywords": "Nix, NixOS, packaging, Linux, deployment, build systems, reproducible, developer" + "property=og:locale": "en_US" +--- + + +# Welcome to nix.dev + +:::{topic} **Introduction** +The Nix ecosystem is a DevOps toolkit to achieve: + +- {ref}`Reproducible development environments `. +- Easy installation of software over URLs. +- Easy transfer of software environments between computers. +- {ref}`Declarative specification of Linux machines `. +- {ref}`Reproducible integration testing using virtual machines `. +- Avoidance of version conflicts with already installed software. +- Installing software from source code. +- {ref}`Transparent build caching using binary caches `. +- Strong support for software auditability. +- {ref}`First-class cross compilation support `. +- Remote builds. +- Remote deployments. +- Atomic upgrades and rollbacks. + +This documentation supplements the official [Nix](http://nixos.org/nix/manual/), +[NixOS](http://nixos.org/nixos/manual/), [Nixpkgs](http://nixos.org/nixpkgs/manual/) +and [NixOps](http://nixos.org/nixops/manual/) manuals. +::: + +```{toctree} +:glob: true +:maxdepth: 3 + +tutorials/index.rst +templates/index.rst +anti-patterns/index.rst +reference/index.rst +faq.rst +recommended-reading.rst +influences.rst +glossary.rst +``` diff --git a/source/index.rst b/source/index.rst deleted file mode 100644 index cfd609b..0000000 --- a/source/index.rst +++ /dev/null @@ -1,42 +0,0 @@ -Welcome to nix.dev -================== - -.. meta:: - :description: An opinionated guide for developers wanting to get things done with the Nix ecosystem. - :keywords: Nix, NixOS, packaging, Linux, deployment, build systems, reproducible, developer - -.. topic:: **Introduction** - - The Nix ecosystem is a DevOps toolkit to achieve: - - - :ref:`Reproducible development environments `. - - Easy installation of software over URLs. - - Easy transfer of software environments between computers. - - :ref:`Declarative specification of Linux machines `. - - :ref:`Reproducible integration testing using virtual machines `. - - Avoidance of version conflicts with already installed software. - - Installing software from source code. - - :ref:`Transparent build caching using binary caches `. - - Strong support for software auditability. - - :ref:`First-class cross compilation support `. - - Remote builds. - - Remote deployments. - - Atomic upgrades and rollbacks. - - This documentation supplements the official `Nix `_, - `NixOS `_, `Nixpkgs `_ - and `NixOps `_ manuals. - - -.. toctree:: - :maxdepth: 3 - :glob: - - tutorials/index.rst - templates/index.rst - anti-patterns/index.rst - reference/index.rst - faq.rst - recommended-reading.rst - influences.rst - glossary.rst diff --git a/source/recommended-reading.md b/source/recommended-reading.md new file mode 100644 index 0000000..5ee3b5d --- /dev/null +++ b/source/recommended-reading.md @@ -0,0 +1,22 @@ +# Recommended reading + +## Nix language tutorials + +- [Learn Nix in Y minutes](https://learnxinyminutes.com/docs/nix/) +- [Nix by Example](https://medium.com/@MrJamesFisher/nix-by-example-a0063a1a4c55) +- [Nix lanuage one-pager reference](https://github.com/tazjin/nix-1p) +- [Video: Nix language overview](https://www.youtube.com/watch?v=eCapIx9heBw&list=PL-saUBvIJzOkjAw_vOac75v-x6EzNzZq-&index=5) + +## [Manage your dot files with Home Manager](https://ghedam.at/24353/tutorial-getting-started-with-home-manager-for-nix) + +## [Nix Pills](https://nixos.org/nixos/nix-pills/index.html) + +To feel comfortable with Nix and Nixpkgs internals, read the pills. + +## [Nix Shorts](https://github.com/justinwoo/nix-shorts) + +A series of posts on basics of how packaging with Nix works. + +## [awesome-nix](https://nix-community.github.io/awesome-nix/) + +A collection of Nix resources. diff --git a/source/recommended-reading.rst b/source/recommended-reading.rst deleted file mode 100644 index 75d81e6..0000000 --- a/source/recommended-reading.rst +++ /dev/null @@ -1,29 +0,0 @@ -Recommended reading -=================== - -Nix language tutorials ----------------------- - -- `Learn Nix in Y minutes `_ -- `Nix by Example `_ -- `Nix lanuage one-pager reference `_ -- `Video: Nix language overview `_ - -`Manage your dot files with Home Manager `_ ------------------------------------------------------------------------------------------------------------------------ - -`Nix Pills `_ ------------------------------------------------------------ - -To feel comfortable with Nix and Nixpkgs internals, read the pills. - - -`Nix Shorts `_ -------------------------------------------------------- - -A series of posts on basics of how packaging with Nix works. - -`awesome-nix `_ -------------------------------------------------------------- - -A collection of Nix resources.