From 2d95e222977fbee6f3fbf1433ce5dac890250d89 Mon Sep 17 00:00:00 2001 From: 6r1d Date: Fri, 8 Jul 2022 16:34:16 +0300 Subject: [PATCH] [documentation] hyperledger#2448 adds a spoiler to issue templates Signed-off-by: 6r1d --- .github/ISSUE_TEMPLATE/lts-bug.yml | 17 +++++++++++++---- .github/ISSUE_TEMPLATE/stable-bug.yml | 17 +++++++++++++---- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/lts-bug.yml b/.github/ISSUE_TEMPLATE/lts-bug.yml index 43c13e57524..bf30f490e56 100644 --- a/.github/ISSUE_TEMPLATE/lts-bug.yml +++ b/.github/ISSUE_TEMPLATE/lts-bug.yml @@ -91,10 +91,19 @@ body: description: | Please provide an output log in JSON format. To configure a file path and level for logs, check the [reference documentation](https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/references/config.md#logger) or [peer configuration](https://hyperledger.github.io/iroha-2-docs/guide/configure/peer-configuration.html#logger). - Note: it is helpful to have JSON [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) enabled. - placeholder: | - ```json - ``` + + Notes: + * please leave JSON [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) and [collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) (`
` tag) enabled + * if the log indentation is broken, use the [js-beautify](https://beautifier.io/) service to format it. + value: | +
+ Spoiler + + ```json + Replace this text with a JSON log, + so it doesn't grow too large and has highlighting. + ``` +
validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/stable-bug.yml b/.github/ISSUE_TEMPLATE/stable-bug.yml index e6a865150ca..63bd4bd79e9 100644 --- a/.github/ISSUE_TEMPLATE/stable-bug.yml +++ b/.github/ISSUE_TEMPLATE/stable-bug.yml @@ -91,10 +91,19 @@ body: description: | Please provide an output log in JSON format. To configure a file path and level for logs, check the [reference documentation](https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/references/config.md#logger) or [peer configuration](https://hyperledger.github.io/iroha-2-docs/guide/configure/peer-configuration.html#logger). - Note: it is helpful to have JSON [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) enabled. - placeholder: | - ```json - ``` + + Notes: + * please leave JSON [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) and [collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) (`
` tag) enabled + * if the log indentation is broken, use the [js-beautify](https://beautifier.io/) service to format it. + value: | +
+ Spoiler + + ```json + Replace this text with a JSON log, + so it doesn't grow too large and has highlighting. + ``` +
validations: required: true - type: input