From 84fb036062b879c454188a2a4f7123720a6eb9be Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Thu, 15 Sep 2022 18:16:17 +0200 Subject: [PATCH 1/2] add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. --- .../ISSUE_TEMPLATE/missing_documentation.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/missing_documentation.md diff --git a/.github/ISSUE_TEMPLATE/missing_documentation.md b/.github/ISSUE_TEMPLATE/missing_documentation.md new file mode 100644 index 000000000..84868814f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/missing_documentation.md @@ -0,0 +1,28 @@ +--- +name: Missing or incorrect documentation +about: +title: '' +labels: 'documentation' +assignees: '' + +--- + +## Problem + + + +## Checklist + + + +- [ ] checked [latest Nix manual]\ ([source]) +- [ ] checked [open documentation issues and pull requests] for possible duplicates + +[latest Nix manual]: https://nixos.org/manual/nix/unstable/ +[source]: https://github.com/NixOS/nix/tree/master/doc/manual/src +[open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation + +## Proposal + + + From 875a99eaa483850e7794a495102ce0c97658d89f Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Fri, 16 Sep 2022 09:41:27 +0200 Subject: [PATCH 2/2] fix markdown rendering quirk markdown would interpret parentheses as belonging to the first link without escaping. --- .github/ISSUE_TEMPLATE/missing_documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/missing_documentation.md b/.github/ISSUE_TEMPLATE/missing_documentation.md index 84868814f..8ded9f063 100644 --- a/.github/ISSUE_TEMPLATE/missing_documentation.md +++ b/.github/ISSUE_TEMPLATE/missing_documentation.md @@ -15,7 +15,7 @@ assignees: '' -- [ ] checked [latest Nix manual]\ ([source]) +- [ ] checked [latest Nix manual] \([source]) - [ ] checked [open documentation issues and pull requests] for possible duplicates [latest Nix manual]: https://nixos.org/manual/nix/unstable/