Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
小 白蛋
Datree
Commits
bd4c593a
Unverified
Commit
bd4c593a
authored
3 years ago
by
Eyar Zilberman
Committed by
GitHub
3 years ago
Browse files
Options
Download
Email Patches
Plain Diff
docs: add template for documentation
parent
be2ba067
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
.github/ISSUE_TEMPLATE/documentation_template.md
+29
-0
.github/ISSUE_TEMPLATE/documentation_template.md
with
29 additions
and
0 deletions
+29
-0
.github/ISSUE_TEMPLATE/documentation_template.md
0 → 100644
+
29
-
0
View file @
bd4c593a
---
name
:
Documentation Template
about
:
Use this template to propose changes and updates to documentation
title
:
"
"
labels
:
documentation
assignees
:
"
"
---
**Report Type**
-
[ ] Missing documentation
-
[ ] Fix current documentation (errors)
**What is the URL of the documentation (if applicable)?**
-
Example:https://hub.datree.io/schema-validation
**What can be improved?**
A clear and concise description of what can be improved.
Examples:
-
"I don't understand where the ${XYZ} variable is set."
-
"There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'."
-
"When I run
`command sub-command ...`
I get the following error:"
-
"I don't know what is meant by 'gerble barb gazoink
`
in the instructions".
**Suggested Solution**
Detail proposed changes to update the documentation if you have any.
**Acceptance Criteria**
Provide requirements to test that the documentation is correct
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment