CipherLabs
/
besu-docs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

create issue forms (#1143)

Browse Source 
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
pull/1150/head
Nicolas MASSART 2 years ago committed by GitHub
parent d81e43cd48
commit a7c4bacf5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 190 additions and 65 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 32
      .github/ISSUE_TEMPLATE/content_issue.md
  2. 75
      .github/ISSUE_TEMPLATE/content_issue.yml
  3. 33
      .github/ISSUE_TEMPLATE/tool_issue.md
  4. 115
      .github/ISSUE_TEMPLATE/tool_issue.yml

32
.github/ISSUE_TEMPLATE/content_issue.md
Unescape View File

@ -1,32 +0,0 @@
---
name: Doc content issue report
about: Create a report to help us improve our content.
title: ''
---
<!-- IMPORTANT: This is only for reporting documentation content issues.
Report Besu software issues at https://github.com/hyperledger/besu/issues.
Report documentation tool issues using the "Documentation tool bug report" template.
Before creating an issue, did you use the search field in the documentation to find what you're looking for?
-->
## Describe the bug
<!-- Add a clear and concise description of what the documentation issue is.
Also, check the issue type in the following list: -->
- [ ] Missing content
- [ ] Outdated content
- [ ] Wrong content
- [ ] Confusing or misleading content
- [ ] Other
## Change suggestion
<!-- If you know how to fix the content, provide a suggestion. -->
## More context
<!-- Add any other context about the problem here, for example, screenshots or a small demo video. -->

75
.github/ISSUE_TEMPLATE/content_issue.yml
Unescape View File

@ -0,0 +1,75 @@
---
name: Doc content issue report
description: Create a report to help us improve our content.
title: "[Content] "
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
IMPORTANT: This is only for reporting documentation content issues.
Report Besu software issues at https://github.com/hyperledger/besu/issues.
Report documentation tool issues using the "Documentation tool bug report" template.
Before creating an issue, make sure you've tried using the search field in the documentation to find what you're looking for.
- type: textarea
id: description
attributes:
label: Describe the issue
description: Add a clear and concise description of what the documentation issue is and what you expected the content to be.
placeholder: Tell us what you see!
validations:
required: true
- type: input
id: page-url
attributes:
label: What page has the issue?
description: Provide the URL of the page where you found this issue.
placeholder: https://besu.hyperledger.org/en/stable/...
validations:
required: true
- type: dropdown
id: issue-type
attributes:
label: Issue type
description: Select the issue type.
multiple: false
options:
- Missing content
- Outdated content
- Wrong content
- Confusing or misleading content
- Other
validations:
required: true
- type: textarea
id: change-suggestion
attributes:
label: Change suggestion
description: If you know how to fix the content, provide a suggestion.
validations:
required: false
- type: textarea
attributes:
label: More context
description: |
Add any other context about the problem here, for example, screenshots or a small demo video.
Tip: You can attach image and video files by copy and pasting or by selecting this area to highlight it and then dragging files in.
validations:
required: false
- type: checkboxes
id: recommendations
attributes:
label: Besu documentation issue guidelines
description: By checking this box, you confirm that you read and followed the [Besu documentation issue guidelines](https://wiki.hyperledger.org/display/BESU/Raise+issues).
options:
- label: I read and followed this project's documentation guidelines.
required: true

33
.github/ISSUE_TEMPLATE/tool_issue.md
Unescape View File

@ -1,33 +0,0 @@
---
name: Doc tool bug report
about: Create a report to help us improve our doc tools.
title: ''
labels: bug
assignees: 'NicolasMassart'
---
<!-- IMPORTANT: This is only for reporting documentation tool bugs.
Report Besu software issues at https://github.com/hyperledger/besu/issues.
Report documentation content issues using the "Documentation content issue report" template.
Before creating an issue, did you refresh your browser cache for the site?
-->
## Describe the bug
<!-- Add a clear and concise description of what the documentation bug is.
Include steps to reproduce the bug and what you expected to happen. -->
## System settings
<!-- Add the following information about your system: -->
- OS and version:
- Browser and version:
- Plugins activated in your browser:
## More context
<!-- Add any other context about the problem here, for example, screenshots or a small demo video. -->

115
.github/ISSUE_TEMPLATE/tool_issue.yml
Unescape View File

@ -0,0 +1,115 @@
---
name: Doc tool issue report
description: Create a report to help us improve our doc tools.
title: "[Doc tooling] "
labels: ["triage"]
assignees: 'NicolasMassart'
body:
- type: markdown
attributes:
value: |
IMPORTANT: This is only for reporting documentation tool issues.
Report Besu software issues at https://github.com/hyperledger/besu/issues.
Report documentation content issues using the "Documentation content issue report" template.
Before creating an issue, make sure you've refreshed your browser cache for the site.
- type: textarea
id: description
attributes:
label: Describe the issue
description: |
Add a clear and concise description of what the documentation tool issue is.
Include steps to reproduce the bug.
placeholder: |
- Step 1: Open the page
- Step 2: Select the button
- Step 3: Notice that feature X is not showing data Y
validations:
required: true
- type: textarea
id: expected
attributes:
label: Describe the expected behavior
description: |
Add a clear and concise description of what you expected to happen.
placeholder: |
I expected feature X to show data Y when selecting the button.
validations:
required: true
- type: input
id: page-url
attributes:
label: What page has this issue?
description: |
Provide the URL of the page where you experienced this issue.
If this issue is present on all the pages, simply point to the home page.
placeholder: https://besu.hyperledger.org/en/stable/...
validations:
required: true
- type: input
id: version
attributes:
label: What version of the doc has this issue?
description: Provide the version of doc with the issue.
placeholder: latest, stable, 1.2.3, ...
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: Select the operating system where you experienced the issue.
multiple: false
options:
- Windows
- macOS
- Linux
- Android
- iOS
- Other
- All of them
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser
description: Select the browser where you experienced the issue.
multiple: false
options:
- Chrome
- Edge
- Firefox
- Safari
- Brave
- Other
- All of them
validations:
required: true
- type: textarea
attributes:
label: More context
description: |
Add any other context about the problem here, for example, screenshots or a small demo video.
Tip: You can attach image and video files by copy and pasting or by selecting this area to highlight it and then dragging files in.
validations:
required: false
- type: checkboxes
id: recommendations
attributes:
label: Besu documentation issue guidelines
description: By checking this box, you confirm that you read and followed the [Besu documentation issue guidelines](https://wiki.hyperledger.org/display/BESU/Raise+issues).
options:
- label: I read and followed this project's documentation guidelines.
required: true
Write Preview
Loading…
Cancel
Save