Commit graph

17 commits

Author SHA1 Message Date
Nicolas Benes
5c8d6d6cee doc: fix broken link
The file was renamed/modified in 3f40ca4 but the documentation was not
updated. Closes #155049.
2022-01-15 16:07:55 +01:00
Jan Tojnar
f24037746d
Merge pull request #149867 from erikarvstedt/docs-stable-release
docs: improve section `Stable release branches`
2021-12-30 16:29:39 +01:00
Erik Arvstedt
af46a4d635
docs: improve section Stable release branches
- Explain branch naming scheme for stable release branches
- Split into subsections `Automatically backporting ...` and
  `Manually backporting...`.
2021-12-28 12:09:28 +01:00
Guillaume Girol
a15fbab8e9 doc: minimize mentions of nix-env -i without -A in nixpkgs manual 2021-12-18 12:00:00 +00:00
Niklas Hambüchen
3c29ced243 CONTRIBUTING.md: Move to repo root, where it is more visible.
We found that many users found it difficult to locate this document.

Github supports it in the root, see:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
2021-06-26 04:51:38 +02:00
Jonathan Ringer
0a6008f4e5 doc/manual: Add backport criteria 2021-06-09 00:13:49 -07:00
Jan Tojnar
6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Domen Kožar
51c7afa95e
backport action: document the workflow 2021-05-25 09:47:33 +02:00
Alyssa Ross
dc3dea22be doc/submitting-changes: should -> must
To me, as a native English speaker, this doesn't change the meaning of
the sentence at all.  But to a non-native speaker, this can read like
the staging-next rules are only recommendations.  Let's make this
clearer.
2021-05-23 20:26:32 +00:00
Patrick Hilhorst
04f82b9ebd doc/submitting-changes: remove incorrect remark
Tests don't only apply to NixOS modules, see for example tests/vscodium
2021-04-26 11:47:42 -04:00
Samuel Dionne-Riel
5ce39b7ee1
Merge pull request #116475 from davidak/doc-remove-packages
doc: add instructions to remove a package
2021-04-21 20:14:24 -04:00
davidak
c0b5d5bb9e doc: add instructions to remove a package
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-04-20 22:29:52 +02:00
Pamplemousse
1adef4a878 documentation: Add content about Vulnerability roundups
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-03-17 13:39:24 -07:00
Thomas Bereknyei
9c4839fe86 docs: clarify staging
Specify that the merges from master to staging-next to staging are
performed by GitHub actions. This helps the reader understand the
relationship between the branches.
2021-02-19 07:56:09 +01:00
Jan Tojnar
ba11a96653
doc: Add staging workflow diagram 2020-12-09 05:26:55 +01:00
Jan Tojnar
cc3228e0bb
doc: Clean up submitting changes 2020-12-05 13:03:22 +01:00
Jan Tojnar
035960e4f6
doc: convert Submitting changes to Markdown 2020-12-05 12:43:25 +01:00