Skip to content

Commit 302864d

Browse files
rjrudinyakov-feldman
authored andcommitted
DHFPROD-7064: Updating Github templates
Simplified them, and directing customers and employees to Support / JIRA when appropriate.
1 parent 9ab16c3 commit 302864d

File tree

3 files changed

+27
-53
lines changed

3 files changed

+27
-53
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,7 @@
1-
### Welcome Hub enthusiast!
1+
If you are a licensed MarkLogic customer and you believe you've identified a bug, please contact Support first.
22

3-
Let's get the most out of this ticket.
3+
If you are a MarkLogic employee, please use our internal JIRA instance to report an issue in the DHFPROD project.
44

5-
#### The issue
5+
**Issue details**
66

7-
Short description of the problem:
8-
9-
What behavior are you expecting?
10-
11-
#### Tech details
12-
13-
Which Operating System are you using?
14-
15-
Which version of MarkLogic are you using?
16-
17-
Which version of Data Hub are you using?
18-
19-
Is this a QuickStart UI bug? If so, which browser are you using?
20-
21-
#### The devil is in the details...
22-
23-
If possible, rerun the command with -d for debugging output and attach the output:
24-
25-
**for quickstart:**
26-
`java -jar quickstart.war -d > myoutput.txt`
27-
28-
**for gradle:**
29-
`gradle mlYourCommand -d > myoutput.txt`
7+
Please provide the details of your issue here.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,35 @@ assignees: ''
77

88
---
99

10-
*### Welcome Hub enthusiast!
10+
If you are a licensed MarkLogic customer, please contact Support first.
1111

12-
Let's get the most out of this ticket, please fill out this template.
12+
If you are a MarkLogic employee, please use our internal JIRA instance to report an issue of type Bug in the DHFPROD project.
1313

14-
#### The issue
14+
Otherwise, please use this template to report the bug you've run into.
15+
### The issue
1516

16-
Short description of the problem:
17+
Please provide reproducible steps for the issue and a description of what behavior you expected instead.
1718

18-
What behavior are you expecting?
19+
The steps to reproduce the issue (use as many numbered steps as you need):
1920

20-
What are the steps to reproduce the issue:
2121
1)
2222
2)
2323
3)
2424

25-
#### Tech details
25+
What behavior were you expecting?
2626

27-
Which Operating System are you using?
27+
### Technical details
2828

29-
Which version of MarkLogic are you using?
29+
Please provide the following version information:
3030

31-
Which version of the Data Hub are you using?
31+
- Operating System =
32+
- MarkLogic =
33+
- Data Hub =
3234

33-
Is this a QuickStart UI bug? If so, which browser are you using?
35+
If this is a Hub Central or QuickStart issue, please provide the browser version too:
3436

35-
#### The devil is in the details...
37+
### Additional details
3638

37-
If possible, rerun the command with -d for debugging output and attach the output:
39+
If the bug involves running Gradle, please run the task that failed with "-i" and "--stacktrace" and include the output as an attachment - e.g. :
3840

39-
**for quickstart:**
40-
`java -jar marklogic-datahub-<version>.war --debug > myoutput.txt`
41-
42-
**for gradle:**
43-
`gradle mlYourCommand -debug > myoutput.txt`
41+
./gradlew yourTask -i --stacktrace > output.txt

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,14 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
If you are a MarkLogic employee, please use our internal JIRA instance to report an issue of type Story in the DHFPROD project.
1211

13-
**What is the user-facing scenario that prompted this gap in functionality?**
12+
Otherwise, please complete the following template to submit your feature request.
1413

15-
**Describe the solution you'd like**
16-
A clear and concise description of what you want to happen.
14+
**What gap would you like Data Hub Framework to address?**
15+
16+
Provide a clear and concise description of what you're not able to do yet with DHF, along with why you would like this gap to be addressed - i.e. what business problem is driving it.
1717

18-
**Describe alternatives you've considered**
19-
A clear and concise description of any alternative solutions or features you've considered.
18+
**Describe the solution you'd like**
2019

21-
**Additional context**
22-
Add any other context or screenshots about the feature request here.
20+
Provide a clear and concise description of how you would like for Data Hub Framework to support the gap that you identified above.

0 commit comments

Comments
 (0)