Commit Graph

68 Commits

Author SHA1 Message Date
pennae
1229e735ac nixos-render-docs: add structural includes, use for manual
this adds support for structural includes to nixos-render-docs.
structural includes provide a way to denote the (sub)structure of the
nixos manual in the markdown source files, very similar to how we used
literal docbook blocks before, and are processed by nixos-render-docs
without involvement of xml tooling. this will ultimately allow us to
emit the nixos manual in other formats as well, e.g. html, without going
through docbook at all.

alternatives to this source layout were also considered:

a parallel structure using e.g. toml files that describe the document
tree and links to each part is possible, but much more complicated to
implement than the solution chosen here and makes it harder to follow
which files have what substructure. it also makes it much harder to
include a substructure in the middle of a file.

much the same goes for command-line arguments to the converter, only
that command-lined arguments are even harder to specify correctly and
cannot be reasonably pulled together from many places without involving
another layer of tooling. cli arguments would also mean that the manual
structure would be fixed in default.nix, which is also not ideal.
2023-02-12 13:02:42 +01:00
Naïm Favier
d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
ajs124
817ca3699e treewide: change postgresql_10 in documentation and examples to postgresql_14 2022-08-15 22:36:32 +02:00
adisbladis
f535d6f45e nixos-container: Use new configuration & state directories
We need to move NixOS containers somewhere else so these don't clash
with Podman, Skopeo & other container software in the libpod &
cri-o/cri-u/libcontainer ecosystems.

The state directory move is not strictly a requirement but is good for
consistency.
2022-04-27 18:35:08 +12:00
ajs124
757dd008b2 postgresql_9_6: drop 2021-12-03 01:14:29 +01:00
Joachim Breitner
f6fffb2722 Nixos manual: nixos-rebuild boot or switch to clear boot entries
the `nixos-rebuild` command has multiple subcommands, and not each of
them would fix the problem of a large `/boot` partition, so let’s be
more precise here.
2021-10-28 12:08:37 +02:00
Bobby Rong
3d711cfc5e
nixos: nixos/doc/manual/administration/troubleshooting.xml to CommonMark 2021-09-08 14:42:23 +08:00
Bobby Rong
5aaeddee5f
nixos: nixos/doc/manual/administration/containers.xml to CommonMark 2021-09-08 14:40:26 +08:00
Jörg Thalheim
0d789e992f
Merge pull request #128937 from bobby285271/pr8
nixos/doc: convert "Chapter 55. Container Management" to CommonMark
2021-09-07 06:24:21 +01:00
Jörg Thalheim
5de68de484
Merge pull request #128935 from bobby285271/pr7
nixos/doc: convert "Chapter 56. Troubleshooting" to CommonMark
2021-09-07 06:20:47 +01:00
Jörg Thalheim
c0735214e1
Merge pull request #129083 from bobby285271/pr12
nixos/doc: convert Chapter 49, 50, 51, 52, 53, 54 to CommonMark
2021-09-07 06:19:33 +01:00
Bobby Rong
b69b26c1a1 nixos: use only URI fragment in manual options links 2021-07-04 08:56:20 +08:00
Bobby Rong
9f7f6d2256 nixos: nixos/doc/manual/administration typo fix
Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
2021-07-03 23:20:39 +08:00
jakobrs
2e4849b841 installation-cd-base.nix: Add 'live.nixos.passwd' boot option
For interactive SSH access to a system without a (working)
keyboard and monitor, without rebuilding the image itself.
2021-07-03 09:53:16 +02:00
Bobby Rong
c603692b0c nixos: nixos/doc/manual/administration/cleaning-store.xml to CommonMark 2021-07-03 14:35:18 +08:00
Bobby Rong
e4ad7d6fc7 nixos: nixos/doc/manual/administration/logging.xml to CommonMark 2021-07-03 14:34:58 +08:00
Bobby Rong
e63f523491 nixos: nixos/doc/manual/administration/control-groups.xml to CommonMark 2021-07-03 14:33:50 +08:00
Bobby Rong
8ee759d7cf nixos: nixos/doc/manual/administration/user-sessions.xml to CommonMark 2021-07-03 14:32:35 +08:00
Bobby Rong
adbe4e34d6 nixos: nixos/doc/manual/administration/rebooting.xml to CommonMark 2021-07-03 14:31:57 +08:00
Bobby Rong
d37933c01f nixos: nixos/doc/manual/administration/service-mgmt.xml to CommonMark 2021-07-03 14:31:14 +08:00
Bobby Rong
9b52df304b nixos: nixos/doc/manual/administration/container-networking.xml to CommonMark 2021-07-02 11:59:12 +08:00
Bobby Rong
4f0efa8d7d nixos: nixos/doc/manual/administration/declarative-containers.xml to CommonMark 2021-07-02 11:58:34 +08:00
Bobby Rong
0ac3e57ac1 nixos: nixos/doc/manual/administration/imperative-containers.xml to CommonMark 2021-07-02 11:57:33 +08:00
Bobby Rong
828474abfb nixos: nixos/doc/manual/administration/network-problems.xml to CommonMark 2021-07-02 10:49:14 +08:00
Bobby Rong
4df0b9903d nixos: nixos/doc/manual/administration/store-corruption.xml to CommonMark 2021-07-02 10:48:31 +08:00
Bobby Rong
99493b61ea nixos: nixos/doc/manual/administration/rollback.xml to CommonMark 2021-07-02 10:47:32 +08:00
Bobby Rong
b5215f3f73 nixos: nixos/doc/manual/administration/maintenance-mode.xml to CommonMark 2021-07-02 10:46:34 +08:00
Ryan Mulligan
77cfa5fd07 nixos/doc: convert boot problems section to CommonMark 2021-06-07 20:14:20 -07:00
Michele Guerini Rocco
25d15ebffb
Merge pull request #98661 from doronbehar/doc/nixos/systemd-nixos-specific
doc/nixos: Explain better NixOS specific Systemd stuff
2020-11-06 11:52:58 +01:00
Doron Behar
8716b71ea6 doc/nixos: Explain better NixOS specific Systemd stuff
Divide the "Service Management" chapter into two sections. The 1st (the
original) explaining General, not NixOS specific ways to interact with
Systemd. The 2nd section, explaining NixOS specific things worth
knowing.

Explain in the 2nd section a bit NixOS modules and services of Nixpkgs,
and mention `systemd.user.services` option. Give an example
demonstrating how to enable imperatively an upstream provided unit file
for a user. Explain why `systemctl --user enable` doesn't work for the
long term on NixOS.
2020-11-06 11:35:59 +02:00
rnhmjoj
bc62423a87
nixos/doc: convert loaOf options refs to attrsOf 2020-09-02 00:42:51 +02:00
jakobrs
2ee84ca8e2
nixos/manual: Document boot.debug1mounts and clarify what exit does with shell_on_fail (#89365)
* nixos/manual: document boot.debug1mounts

* nixos/manual: clarify what `exit` does with shell_on_fail
2020-06-17 15:36:06 +02:00
Jan Tojnar
e6ce041cae
nixos/doc: Improve code listings
By adding prompts and replaceables and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
Wout Mertens
3202f64465
nixos doc: clarify role of boot.debug1devices
Co-Authored-By: Jörg Thalheim <Mic92@users.noreply.github.com>
2019-11-13 20:39:11 +01:00
Wout Mertens
89c8338b51
nixos boot doc: document boot.debug1devices 2019-11-13 16:35:00 +01:00
Eelco Dolstra
b0ccd6dd16
Revert "nixos/doc: re-format"
This reverts commit ea6e8775bd. The new
format is not an improvement.
2019-09-19 19:17:30 +02:00
Jan Tojnar
ea6e8775bd
nixos/doc: re-format 2019-09-18 22:13:35 +02:00
Jan Tojnar
a3f2131eb6 doc: Use prompt more often 2019-06-17 13:25:50 +02:00
Maximilian Bosch
c957341ef5
nixos-container: allow setting custom local and host address
I have a nixops network where I deploy containers using the `container`
backend which uses `nixos-container` intenrally to deploy several
containers to a certain host.

During that time I removed and added new containers and while trying to
deploy those to a different host I realized that it isn't guaranteed
that each container gets the same IP address which is a problem as some
parts of the deployment need to know which container is using which IP
(i.e. to configure port forwarding on the host).

With this change you can specify the container's IP like this (and don't
have to use the arbitrarily used 10.233.0.0/16 subnet):

```
$ nixos-container create test --config-file test-container.nix \
    --local-address 10.235.1.2 --host-address 10.235.1.1
```
2019-04-22 18:13:45 +02:00
Guillaume Maudoux
473a3ef606 nixos/manual: add dummy ids to silence warnings 2019-02-08 10:23:57 +01:00
Alyssa Ross
c6c7d55790
postgresql*: use underscores in version numbers 2018-10-30 14:32:21 +00:00
Léo Gaspard
861b70f483
nixos manual: automatic reflow 2018-10-15 23:10:55 +09:00
Samuel Dionne-Riel
7fb45271b2
Merge pull request #47917 from arianvp/fix-imperative-containers
Fix imperative containers
2018-10-08 16:55:38 -04:00
Matthew Bauer
52ed0526fe
Merge pull request #45978 from fgaz/patch-1
nixos docs: system restart to apply containers nat
2018-10-08 13:48:14 -05:00
Arian van Putten
bb31835b1d Revert "Revert "Revert "doc: Update section about imperative containers"""
nixos-container can now execute nix commands again inside the container

This reverts commit 9622cd3b38.
2018-10-05 18:36:56 +02:00
Graham Christensen
9622cd3b38
Revert "Revert "doc: Update section about imperative containers""
I fixed the problem.

This reverts commit 74df71bc8b.
2018-09-29 20:43:06 -04:00
Tuomas Tynkkynen
74df71bc8b Revert "doc: Update section about imperative containers"
This reverts commit f309440ee3.

Breaks manual build:

https://nix-cache.s3.amazonaws.com/log/wnjcy6n5f871bpyy9nd06smiz1ggv99c-nixos-manual-combined.drv
2018-09-30 03:18:58 +03:00
Arian van Putten
f309440ee3 doc: Update section about imperative containers
Nix commands inside the container have been broken since 18.03,
and no fix is yet in sight.  Lets remove from the documentation
that this is a usecase that we support, as it doesn't seem
likely that this will be fixed before 18.09 either.

See #40355
2018-09-28 13:52:29 +02:00
Francesco Gazzetta
25a14fc261
nixos docs: system restart to apply containers nat 2018-09-03 14:42:48 +02:00
Graham Christensen
4477cf04b6
Document running nixos-rebuild switch to clear /boot space 2018-08-31 21:37:07 -04:00