Skip to content

Commit 5b17a10

Browse files
authored
CI: try enhancing the templates of the new issues (#214)
- make the templates more proper to point to the proper site and type always
2 parents 71bfa05 + c3426e9 commit 5b17a10

File tree

5 files changed

+33
-6
lines changed

5 files changed

+33
-6
lines changed

.github/ISSUE_TEMPLATE/20-documentation-issue.md renamed to .github/ISSUE_TEMPLATE/10-doc-issue.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
---
2-
name: Documentation issue
2+
name: 📚 Documentation issue
33
about: Use this template for reporting an issue in the documentation.
44
title: ''
55
labels: 'documentation'
66
assignees: ''
77

88
---
99

10+
<!--
11+
*******************
12+
PLEASE TAKE CARE!!!
13+
*******************
14+
15+
This is a syslog-ng documentation related ONLY request.
16+
17+
For creating issue request related to the syslog-ng application, use
18+
19+
https://github.com/syslog-ng/syslog-ng/issues/new/choose
20+
21+
-->
22+
1023
## Incorrect section
1124
<!-- Which section of the documentation is wrong? Please include a link to it, if that is possible. -->
1225

.github/ISSUE_TEMPLATE/10-bug-report.md renamed to .github/ISSUE_TEMPLATE/20-doc-building-bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Bug report
2+
name: 📚 Documentation building bug report
33
about: Use this template for reporting a bug related to building the documentation.
44
title: ''
55
labels: bug

.github/ISSUE_TEMPLATE/30-feature-request.md renamed to .github/ISSUE_TEMPLATE/30-doc-feature-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: Feature request
3-
about: Use this template for raising a feature request.
2+
name: 📚 Documentation feature request
3+
about: Use this template for raising a feature request for the documentation site.
44
title: ''
55
labels: 'enhancement'
66
assignees: ''

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚❓ Ask a Documentation question
4+
url: https://github.com/syslog-ng/syslog-ng.github.io/discussions
5+
about: Ask questions and discuss the documentation related topics with other community members
6+
- name: Create a syslog-ng application issue
7+
url: https://github.com/syslog-ng/syslog-ng/issues
8+
about: Use this template for reporting an issue in the syslog-ng application.
9+
- name: Create a syslog-ng application feature request
10+
url: https://github.com/syslog-ng/syslog-ng/issues
11+
about: Use this template for creating a feature request in the syslog-ng application.
12+
- name: ❓ Ask a syslog-ng application question
13+
url: https://github.com/syslog-ng/syslog-ng/discussions
14+
about: Ask questions and discuss the syslog-ng application related topics with other community members

_includes/page__contribution.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% if site.github.repository_url %}
22
{% assign contrib_view = site.github.repository_url | append: '/tree/master/' | append: site.collections_dir | append: '/' | append: page.relative_path %}
33
{% assign contrib_edit = site.github.repository_url | append: '/edit/master/' | append: site.collections_dir | append: '/' | append: page.relative_path %}
4-
{% assign contrib_report = site.github.repository_url | append: '/issues/new?title=Issue with ' | append: page.relative_path %}
4+
{% assign contrib_report = site.github.repository_url | append: '/issues/new?template=10-doc-issue.md&title=Issue with `' | append: page.title | append: '` [' | append: page.relative_path | append: ']' %}
55

66
<aside class="sidebar__right sticky contrib">
77
<div class="align-right">
@@ -14,7 +14,7 @@
1414
</button>
1515

1616
<button id="report" class="masthead_button" type="button" onclick="window.open('{{contrib_report}}', '_blank')">
17-
<i class="masthead_button_icon fas fa-bug content-tooltip tooltip-align-center text-content-tooltip" data-tooltip-text="Report an issue"></i>
17+
<i class="masthead_button_icon fas fa-bug content-tooltip tooltip-align-center text-content-tooltip" data-tooltip-text="Report a documentation issue"></i>
1818
</button>
1919
</div>
2020
</aside>

0 commit comments

Comments
 (0)