summaryrefslogtreecommitdiff
path: root/doc/contributing (follow)
Commit message (Expand)AuthorAgeFilesLines
* doc: fix typoSandro Jäckel2021-10-281-1/+1
* doc/contributing: add lib.optional (#121251)•••Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>Sandro2021-10-051-0/+15
* Merge pull request #130047 from NixOS/doc-manpage-role•••doc: Add support for manpage referencesJan Tojnar2021-09-071-0/+7
|\
| * doc: Linkify man page referencesJan Tojnar2021-07-131-1/+3
| * doc: Add support for MyST roles•••Officially, only the manpage role is supported at the moment. Unlike in rST, the syntax uses braces instead of colons: {manpage}`nix.conf(5)` Jan Tojnar2021-07-131-0/+5
* | nixpkgs-docs: when to prefer passthru.tests over installCheckPhase•••And mention you can have either lightweight 'package' or more heavyweight 'NixOS' (module) tests. This was suggested at https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971 and discussed further at https://github.com/NixOS/nixpkgs/pull/119731 Arnout Engelen2021-08-141-1/+20
* | Merge pull request #130207 from hercules-ci/passthru-sensible-timeout•••doc/coding-conventions: Increase passthru test timeout 3s -> 60sdavidak2021-08-021-1/+1
|\ \
| * | doc/coding-conventions: Increase passthru test timeout 3s -> 60s•••3s is too small a margin for a loaded slow system to start a bloated program. This leads to problems when tests are written on decent dev hardware but later run on build farms of potentially slower hardware, particularly in the case of non x86. The chance of needing the timeout is actually very small, so those rare 57s are a reasonable price to pay for fewer timeouts on build farms, each of which should be investigated and usually fixed by increasing the timeout. Robert Hensing2021-07-141-1/+1
| |/
* | Merge pull request #126001 from est31/master•••Add the -a param to the docsRyan Mulligan2021-07-281-1/+1
|\ \
| * | Add the -a param to the docs•••The patch utility does not understand git formatted patches. For text files, there is no problem, but binary files use the git format. The -a param makes git diff put binary files into the patch in raw format that can be understood by the patch tool. est312021-06-061-1/+1
* | | manuals: Describe how to link NixOS tests from packagesNiklas Hambüchen2021-07-271-1/+27
| |/ |/|
* | 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 Niklas Hambüchen2021-06-261-2/+2
* | doc/manual: Add backport criteriaJonathan Ringer2021-06-091-0/+11
* | doc: Use markdown syntax for xrefs•••Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing Jan Tojnar2021-06-073-3/+8
* | 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. Jan Tojnar2021-06-074-5/+10
* | doc: Document markup syntax•••Not depicted: - Diagrams using Lua filter and dot - fenced code attributes (enabled by the attributes extension) Jan Tojnar2021-06-061-1/+71
|/
* Merge pull request #125494 from siraben/remove-stdenv-libSandro2021-06-051-3/+0
|\
| * coding-conventions: remove reference to stdenv.libBen Siraphob2021-06-031-3/+0
* | doc: Fix make in nix-shell•••When running make manually, makeFlags will not be passed. Let’s just use an environment variable. Jan Tojnar2021-06-051-1/+1
|/
* doc/coding-conventions: Add documentation for fetchpatch optional argumentsStefan Frijters2021-05-281-0/+10
* backport action: document the workflowDomen Kožar2021-05-251-0/+2
* 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. Alyssa Ross2021-05-231-1/+1
* Merge pull request #121252 from NixOS/SuperSandro2000-patch-1•••doc/contributing: add unnecessary string conversionsSandro2021-05-171-0/+12
|\
| * doc/contributing: add unnecessary string conversionsSandro2021-04-301-0/+12
* | Merge pull request #120534 from davidak/package-tests•••doc: add instructions for creating package testsLuke Granger-Brown2021-05-011-0/+70
|\ \
| * | doc: add instructions for creating package testsdavidak2021-04-241-0/+70
* | | doc/contributing: clarify stdenv.lib deprecationSandro2021-04-301-1/+2
| |/ |/|
* | doc/submitting-changes: remove incorrect remark•••Tests don't only apply to NixOS modules, see for example tests/vscodium Patrick Hilhorst2021-04-261-1/+1
|/
* doc/contributing/*.xml: Convert to markdownBobby Rong2021-04-238-1613/+819
* Merge pull request #116475 from davidak/doc-remove-packages•••doc: add instructions to remove a packageSamuel Dionne-Riel2021-04-211-0/+46
|\
| * doc: add instructions to remove a package•••Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com> davidak2021-04-201-0/+46
* | docs: correct some englishEvils2021-04-201-11/+11
* | documentation: Add content about Vulnerability roundups•••Signed-off-by: Pamplemousse <xav.maso@gmail.com> Pamplemousse2021-03-172-9/+55
|/
* doc: FormatRobert Hensing2021-03-041-9/+3
* 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. Thomas Bereknyei2021-02-191-1/+4
* Merge pull request #109663 from Pamplemousse/documentation•••documention correctionsRobert Hensing2021-01-261-1/+1
|\
| * documentation: correct documentation help•••`PANDOC_LUA_FILTERS_DIR` is set in `makeFlags` in `doc/default.nix`, and needs to be explicitely passed to `make` when called manually. Signed-off-by: Pamplemousse <xav.maso@gmail.com> Pamplemousse2021-01-191-1/+1
* | doc: add function argument order convention (#110060)•••* doc: add function argument order convention Ordering by usage is the de facto ordering given to arguments. It's logical, and makes finding argument usage easier. Putting lib first is common in NixOS modules, so it's reasonable to mirror this in nixpkgs proper. Additionally, it's not a package as such, has zero dependencies, and can be found used anywhere in a derivation. * doc: clean up usage of libV2021-01-201-0/+6
|/
* doc: add "prefer lib over stdenv.lib" convention•••I think we should have something in the manual people can point to about this, to avoid rehashing it over and over in PRs. "stdenv.lib" makes it look like lib is part of stdenv, which it isn't, and makes it even more confusing as a newcomer to figure out what stdenv is (and isn't). Alyssa Ross2021-01-101-0/+9
* doc: Add staging workflow diagramJan Tojnar2020-12-091-0/+19
* doc: Clean up submitting changesJan Tojnar2020-12-051-34/+19
* doc: convert Submitting changes to MarkdownJan Tojnar2020-12-052-455/+213
* doc: Rename submitting-changes to chapterJan Tojnar2020-12-051-0/+0
* Merge pull request #101806 from unode/docs•••docs: Add 'how to request merging rights'Domen Kožar2020-12-011-5/+5
|\
| * docs: Add link to the GitHub issue on how to become a committerRenato Alves2020-10-291-5/+5
* | doc/contributing: remove label instructions•••ofborg largely does this now Jonathan Ringer2020-11-141-48/+0
* | doc/*: fix indentationzowoq2020-11-121-2/+2
* | A directory-category for terminal emulators•••This is a mostly cosmetical commit, in the sense it doesn't change the contents of any package, but reorganizes the overall Nixpkgs expressions. Terminal emulators are an ubiquitous tool for any Unix user; even the beginners are routinely familiarized to it. And, manifestly, there are many implementations of terminal emulators out there, from those traditionally made in C and C++ to those written in Haskell and Go. Terminal emulators deserve more highlight. This commit does that by creating a category for them. AndersonTorres2020-10-281-0/+10
|/
* doc: Improve code listings•••By adding prompts and removing unnecessary indentation. Jan Tojnar2020-09-231-6/+6
* treewide: use https for nixos.org and hydra.nixos.org•••tarballs.nixos.org is omitted from the change because urls from there are always hashed and checked Pavol Rusnak2020-05-031-1/+1