Commit 54e4669c authored Oct 09, 2023 by Victor Engmark Committed by Valentin Gagarin Oct 25, 2024

docs: Clarify how to provide technical details/metadata



`nix-info -m` outputs Markdown, so it makes more sense to include it in
issues verbatim than within a preformatted code block.

Co-authored-by: Gavin John <gavinnjohn@gmail.com>

parent f705c4d3

.github/ISSUE_TEMPLATE.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -8,4 +8,4 @@

		## Technical details

		Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.
		<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line -->

.github/ISSUE_TEMPLATE/bug_report.md

+1 −5

Original line number	Diff line number	Diff line
		@@ -33,12 +33,8 @@ If in doubt, check `git blame` for whoever last touched something.
		-->

		### Metadata
		Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.

		```console
		[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
		output here
		```
		<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line -->

		---

.github/ISSUE_TEMPLATE/build_failure.md

+1 −6

Original line number	Diff line number	Diff line
		@@ -31,12 +31,7 @@ If in doubt, check `git blame` for whoever last touched something.

		### Metadata

		Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.

		```console
		[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
		output here
		```
		<!-- Please insert the output of running `nix-shell -p nix-info --run "nix-info -m"` below this line -->

		---