diff --git a/README.rst b/README.rst index eae1c891..329315b0 100644 --- a/README.rst +++ b/README.rst @@ -37,6 +37,8 @@ metadata for the project where the docs reside:: # The git SHA checksum is used by "log-a-bug" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" gitsha = os.popen(git_cmd).read().strip('\n') + # tag that reported bugs will be tagged with + bug_tag = "your-chosen-tag" # source tree pwd = os.popen("pwd").read().strip('\n') # html_context allows us to pass arbitrary values into the html template diff --git a/doc/source/conf.py b/doc/source/conf.py index 1d64ef3d..0ce77f49 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,10 +65,13 @@ release = '1.0' # The git SHA checksum is used by "log-a-bug" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" gitsha = os.popen(git_cmd).read().strip('\n') +# tag that reported bugs will be tagged with when using the "log a bug" +# clickthrough on each page, such as user-guide or install-guide +bug_tag = "doc-builds" # source tree pwd = os.popen("pwd").read().strip('\n') # html_context allows us to pass arbitrary values into the html template -html_context = { "pwd":pwd, "gitsha":gitsha } +html_context = { "pwd":pwd, "gitsha":gitsha, "bug_tag": bug_tag} # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/openstackdocstheme/theme/openstackdocs/script_footer.html b/openstackdocstheme/theme/openstackdocs/script_footer.html index 47c251bd..297ae286 100644 --- a/openstackdocstheme/theme/openstackdocs/script_footer.html +++ b/openstackdocstheme/theme/openstackdocs/script_footer.html @@ -16,7 +16,7 @@