mirror of
https://github.com/NixOS/nix.dev.git
synced 2024-10-18 14:32:43 -04:00
Merge pull request #213 from nix-dot-dev/convert_toplevel
Convert the remaining toplevel files
This commit is contained in:
commit
d4915d1b34
14
source/glossary.md
Normal file
14
source/glossary.md
Normal file
|
@ -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.
|
||||||
|
|
||||||
|
```
|
|
@ -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.
|
|
45
source/index.md
Normal file
45
source/index.md
Normal file
|
@ -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 <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}`Reproducible integration testing using virtual machines <integration-testing-vms>`.
|
||||||
|
- Avoidance of version conflicts with already installed software.
|
||||||
|
- Installing software from source code.
|
||||||
|
- {ref}`Transparent build caching using binary caches <github-actions>`.
|
||||||
|
- Strong support for software auditability.
|
||||||
|
- {ref}`First-class cross compilation support <cross-compilation>`.
|
||||||
|
- 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
|
||||||
|
```
|
|
@ -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 <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:`Reproducible integration testing using virtual machines <integration-testing-vms>`.
|
|
||||||
- Avoidance of version conflicts with already installed software.
|
|
||||||
- Installing software from source code.
|
|
||||||
- :ref:`Transparent build caching using binary caches <github-actions>`.
|
|
||||||
- Strong support for software auditability.
|
|
||||||
- :ref:`First-class cross compilation support <cross-compilation>`.
|
|
||||||
- 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::
|
|
||||||
: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
|
|
22
source/recommended-reading.md
Normal file
22
source/recommended-reading.md
Normal file
|
@ -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.
|
|
@ -1,29 +0,0 @@
|
||||||
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.
|
|
Loading…
Reference in a new issue