[documentation] #2446 adds a spoiler to issue templates

Signed-off-by: 6r1d <vic.6r1d@gmail.com>
hyperledger · Jul 8, 2022 · 630d45a · 630d45a
1 parent 1ad7362
commit 630d45a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/lts-bug.yml b/.github/ISSUE_TEMPLATE/lts-bug.yml
@@ -89,12 +89,19 @@ body:
     attributes:
       label: Logs in JSON format
       description: |
-        Please provide an output log in JSON format.
+        Provide an output log in JSON format, so we can determine the what caused the issue faster.
         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
-        ```
+        **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) (`<details>` tag) enabled
+        If the log indentation is broken, use the [js-beautify](https://beautifier.io/) service to format it.
+      value: |
+        <details>
+          <summary>Log contents</summary>
+          
+          ```json
+          Replace this text with a JSON log,
+          so it doesn't grow too large and has highlighting.
+          ```
+        </details>
     validations:
       required: true
   - type: input

diff --git a/.github/ISSUE_TEMPLATE/stable-bug.yml b/.github/ISSUE_TEMPLATE/stable-bug.yml
@@ -89,12 +89,19 @@ body:
     attributes:
       label: Logs in JSON format
       description: |
-        Please provide an output log in JSON format.
+        Provide an output log in JSON format, so we can determine the what caused the issue faster.
         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
-        ```
+        **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) (`<details>` tag) enabled
+        If the log indentation is broken, use the [js-beautify](https://beautifier.io/) service to format it.
+      value: |
+        <details>
+          <summary>Log contents</summary>
+          
+          ```json
+          Replace this text with a JSON log,
+          so it doesn't grow too large and has highlighting.
+          ```
+        </details>
     validations:
       required: true
   - type: input