mirror of
https://gitlab.futo.org/videostreaming/grayjay.git
synced 2025-04-19 19:14:51 +00:00
63 lines
2.5 KiB
YAML
63 lines
2.5 KiB
YAML
name: Documentation Issue
|
|
description: Report an issue or suggest a change in the documentation.
|
|
labels: ["Documentation"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
# Thank you for opening a documentation change request.
|
|
|
|
The [grayjay-android](https://github.com/futo-org/grayjay-android) issue tracker is reserved for issues relating to the Grayjay Android Application. Use the `Documentation` issue type to report problems with the documentation in our code repositories, inside the application, or on [https://grayjay.app](https://grayjay.app)
|
|
Technical writers monitor this issue type, so report Grayjay bugs or feature requests with the `Bug report` or `Feature Request` issue types instead to get engineering attention.
|
|
|
|
For general usage questions, please see: [The Official FUTO Grayjay Zulip Channel](https://chat.futo.org/#narrow/stream/46-Grayjay)
|
|
|
|
- type: textarea
|
|
id: grayjay-affected-pages
|
|
attributes:
|
|
label: Affected Pages
|
|
description: |
|
|
Link to or describe the pages relevant to your documentation change request.
|
|
placeholder:
|
|
value:
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: grayjay-problem
|
|
attributes:
|
|
label: What is the docs issue?
|
|
description: What problems or suggestions do you have about the documentation?
|
|
placeholder:
|
|
value:
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: grayjay-proposal
|
|
attributes:
|
|
label: Proposal
|
|
description: What documentation changes would fix this issue and where would you expect to find them? Are one or more page headings unclear? Do one or more pages need additional context, examples, or warnings? Do we need a new page or section dedicated to a specific topic? Your ideas help us understand what you and other users need from our documentation and how we can improve the content.
|
|
placeholder:
|
|
value:
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: grayjay-references
|
|
attributes:
|
|
label: References
|
|
description: |
|
|
Are there any other open or closed GitLab/GitHub issues related to the problem or solution you described? If so, list them below. For example:
|
|
```
|
|
- #6017
|
|
```
|
|
placeholder:
|
|
value:
|
|
validations:
|
|
required: false
|
|
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
**Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue.
|