Skip to content

Commit d917eed

Browse files
authored
add github label option (#1093)
1 parent 1c80df1 commit d917eed

File tree

4 files changed

+7
-2
lines changed

4 files changed

+7
-2
lines changed

docs/source/configuration/template.rst

+4
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ Configuration options for the Edit on this page button.
187187
- string
188188
-
189189
- Repository organization name and project slug where docs are hosted, separated by a slash (/).
190+
* - ``github_label``
191+
- string
192+
- documentation
193+
- Name of the label to be used when creating an issue on GitHub.
190194
* - ``hide_edit_this_page_button``
191195
- string
192196
- true

sphinx_scylladb_theme/contribute.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{% if theme_github_repository %}
22
<ul class="contribute">
33
<li class="contribute__item">
4-
<a href="https://github.com/{{ theme_github_issues_repository}}/issues/new?title=docs:%20Issue on page {{ title|striptags|e }}&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20{{html_baseurl}}/{% if versions and current_version %}{{ current_version.name }}/{% endif %}{{ pagename }}%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels=documentation"
4+
<a href="https://github.com/{{ theme_github_issues_repository}}/issues/new?title=docs:%20Issue on page {{ title|striptags|e }}&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20{{html_baseurl}}/{% if versions and current_version %}{{ current_version.name }}/{% endif %}{{ pagename }}%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels={{theme_github_label}}"
55
target="_blank">
66
<i class="icon fab fa-github" aria-hidden="true"></i>Create an issue
77
</a>

sphinx_scylladb_theme/feedback.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
const themeGithubRepository = {% if theme_github_repository %}true{% else %}false{% endif %};
2828
let message = 'Great! Thanks for your feedback.';
2929
if (themeGithubRepository && !liked) {
30-
message = "Thanks for your feedback! Please don't hesitate to <a href='https://github.com/{{ theme_github_issues_repository}}/issues/new?title=docs:%20Issue on page {{ title|striptags|e }}&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20{{html_baseurl}}/{% if versions and current_version %}{{ current_version.name }}/{% endif %}{{ pagename }}%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels=documentation'>create an issue</a> if you have any suggestions on how we can improve.";
30+
message = "Thanks for your feedback! Please don't hesitate to <a href='https://github.com/{{ theme_github_issues_repository}}/issues/new?title=docs:%20Issue on page {{ title|striptags|e }}&&body=I%20would%20like%20to%20report%20an%20issue%20on%20page%20{{html_baseurl}}/{% if versions and current_version %}{{ current_version.name }}/{% endif %}{{ pagename }}%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix&labels={{theme_github_label}}'>create an issue</a> if you have any suggestions on how we can improve.";
3131
}
3232
feedbackMessage.innerHTML = message;
3333
}

sphinx_scylladb_theme/theme.conf

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ conf_py_path= docs/source/
1313
default_branch=master
1414
github_issues_repository = scylladb/scylla-doc-issues
1515
github_repository=
16+
github_label=documentation
1617
hide_banner = true
1718
hide_feedback_buttons = true
1819
hide_edit_this_page_button = true

0 commit comments

Comments
 (0)