Merge pull request #66 from co-cddo/feedback-footer

Add feedback footer to all generated pages
co-cddo · Nov 2, 2023 · ed61341 · ed61341
2 parents 1c65cc0 + 9e9f278
commit ed61341
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 1 deletion.
diff --git a/src/docs/templates/class.md.jinja2 b/src/docs/templates/class.md.jinja2
@@ -109,6 +109,8 @@ URI: {{ gen.uri_link(element) }}
 {% endfor %}
 {% endif %}
 
+{% include "feedback_footer.md.jinja2" %}
+
 {%- if footer -%}
 {{footer}}
 {%- endif -%}
diff --git a/src/docs/templates/enum.md.jinja2 b/src/docs/templates/enum.md.jinja2
@@ -37,3 +37,5 @@ _This is a dynamic enum_
 {% endif %}
 
 {% include "common_metadata.md.jinja2" %}
+
+{% include "feedback_footer.md.jinja2" %}
diff --git a/src/docs/templates/feedback_footer.md.jinja2 b/src/docs/templates/feedback_footer.md.jinja2
@@ -0,0 +1,3 @@
+## Provide Feedback
+
+[New GitHub Issue](https://github.com/co-cddo/ukgov-metadata-exchange-model/issues/new?body=Feedback+on+%5B{{ gen.name(element) }}%5D%28{{ "https://co-cddo.github.io/ukgov-metadata-exchange-model/" ~ gen.name(element) | urlencode() }}%29%0A%0A%2A%2ADescribe%20the%20bug%2A%2A%0AA%20clear%20and%20concise%20description%20of%20what%20the%20bug%20is.%0A%0A%2A%2ATo%20Reproduce%2A%2A%0ASteps%20to%20reproduce%20the%20behavior%3A%0A1.%20Go%20to%20%27...%27%0A2.%20Click%20on%20%27....%27%0A3.%20Scroll%20down%20to%20%27....%27%0A4.%20See%20error%0A%0A%2A%2AExpected%20behavior%2A%2A%0AA%20clear%20and%20concise%20description%20of%20what%20you%20expected%20to%20happen.%0A%0A%2A%2AScreenshots%2A%2A%0AIf%20applicable%2C%20add%20screenshots%20to%20help%20explain%20your%20problem.%0A%0A%2A%2ADesktop%20%28please%20complete%20the%20following%20information%29%3A%2A%2A%0A%20-%20OS%3A%20%5Be.g.%20iOS%5D%0A%20-%20Browser%20%5Be.g.%20chrome%2C%20safari%5D%0A%20-%20Version%20%5Be.g.%2022%5D%0A%0A%2A%2ASmartphone%20%28please%20complete%20the%20following%20information%29%3A%2A%2A%0A%20-%20Device%3A%20%5Be.g.%20iPhone6%5D%0A%20-%20OS%3A%20%5Be.g.%20iOS8.1%5D%0A%20-%20Browser%20%5Be.g.%20stock%20browser%2C%20safari%5D%0A%20-%20Version%20%5Be.g.%2022%5D%0A%0A%2A%2AAdditional%20context%2A%2A%0AAdd%20any%20other%20context%20about%20the%20problem%20here.&labels=bug)
diff --git a/src/docs/templates/index.md.jinja2 b/src/docs/templates/index.md.jinja2
@@ -54,3 +54,7 @@
 {% for t in gen.all_type_objects()|sort(attribute=sort_by) -%}
 | {{gen.link(t)}} | {{t.description|enshorten}} |
 {% endfor %}
+
+## Provide Feedback
+
+[New GitHub Issue](https://github.com/co-cddo/ukgov-metadata-exchange-model/issues/new?body=Feedback+on+%5BMetadata Model%5D%28{{ "https://co-cddo.github.io/ukgov-metadata-exchange-model/" | urlencode() }}%29%0A%0A%2A%2ADescribe%20the%20bug%2A%2A%0AA%20clear%20and%20concise%20description%20of%20what%20the%20bug%20is.%0A%0A%2A%2ATo%20Reproduce%2A%2A%0ASteps%20to%20reproduce%20the%20behavior%3A%0A1.%20Go%20to%20%27...%27%0A2.%20Click%20on%20%27....%27%0A3.%20Scroll%20down%20to%20%27....%27%0A4.%20See%20error%0A%0A%2A%2AExpected%20behavior%2A%2A%0AA%20clear%20and%20concise%20description%20of%20what%20you%20expected%20to%20happen.%0A%0A%2A%2AScreenshots%2A%2A%0AIf%20applicable%2C%20add%20screenshots%20to%20help%20explain%20your%20problem.%0A%0A%2A%2ADesktop%20%28please%20complete%20the%20following%20information%29%3A%2A%2A%0A%20-%20OS%3A%20%5Be.g.%20iOS%5D%0A%20-%20Browser%20%5Be.g.%20chrome%2C%20safari%5D%0A%20-%20Version%20%5Be.g.%2022%5D%0A%0A%2A%2ASmartphone%20%28please%20complete%20the%20following%20information%29%3A%2A%2A%0A%20-%20Device%3A%20%5Be.g.%20iPhone6%5D%0A%20-%20OS%3A%20%5Be.g.%20iOS8.1%5D%0A%20-%20Browser%20%5Be.g.%20stock%20browser%2C%20safari%5D%0A%20-%20Version%20%5Be.g.%2022%5D%0A%0A%2A%2AAdditional%20context%2A%2A%0AAdd%20any%20other%20context%20about%20the%20problem%20here.&labels=bug)
diff --git a/src/docs/templates/slot.md.jinja2 b/src/docs/templates/slot.md.jinja2
@@ -86,6 +86,8 @@ _Usage notes still to be provided._
 
 {% include "common_metadata.md.jinja2" %}
 
+{% include "feedback_footer.md.jinja2" %}
+
 {%- if footer -%}
 {{footer}}
 {%- endif -%}
diff --git a/src/docs/templates/type.md.jinja2 b/src/docs/templates/type.md.jinja2
@@ -22,4 +22,6 @@ URI: {{ gen.uri_link(element) }}
 * Numeric Value Range: {{gen.number_value_range(element)}}
 {% endif %}
 
-{% include "common_metadata.md.jinja2" %}
+{% include "common_metadata.md.jinja2" %}
+
+{% include "feedback_footer.md.jinja2" %}