docs(suggest a change): adding information and way for users to sugge…

…st a change (#534) * docs(suggest a change): adding information and way for users to suggest a change * Update docs/community/contribute.md Co-authored-by: Greg Tyler <[email protected]> --------- Co-authored-by: Greg Tyler <[email protected]>
ministryofjustice · Nov 17, 2023 · 421c4bb · 421c4bb
1 parent 4248a77
commit 421c4bb
Show file tree

Hide file tree

Showing 11 changed files with 88 additions and 11 deletions.
diff --git a/docs/_includes/layouts/community.njk b/docs/_includes/layouts/community.njk
@@ -35,12 +35,16 @@
             },
             items: [
             {
-              text: 'Propose a contribution',
+              text: 'Propose a component or pattern',
               href: ('/community/contribute' | url)
             },
             {
               text: 'Contribution criteria',
               href: ('/community/criteria' | url)
+            },
+            {
+              text: 'Suggest a change',
+              href: ('/community/suggest-a-change' | url)
             }
             ]
           },
@@ -70,6 +74,8 @@
         {{ content | safe }}
       </main>
 
+      {% include "./partials/get-help.njk" %}
+
     </div>
   </div>
 {% endblock %}

diff --git a/docs/_includes/layouts/component.njk b/docs/_includes/layouts/component.njk
@@ -154,6 +154,7 @@
         {{ content | safe }}
       </main>
 
+      {% include "./partials/suggest-a-change-and-help.njk" %}
     </div>
   </div>
 {% endblock %}
diff --git a/docs/_includes/layouts/get-started.njk b/docs/_includes/layouts/get-started.njk
@@ -63,6 +63,8 @@
         {{ content | safe }}
       </main>
 
+      {% include "./partials/get-help.njk" %}
+
     </div>
   </div>
 {% endblock %}

diff --git a/docs/_includes/layouts/partials/contact-panel.njk b/docs/_includes/layouts/partials/contact-panel.njk
diff --git a/docs/_includes/layouts/partials/get-help.njk b/docs/_includes/layouts/partials/get-help.njk
@@ -0,0 +1,19 @@
+
+<hr class="govuk-section-break govuk-section-break--l govuk-section-break--visible">
+
+<div class="govuk-!-padding-bottom-3"></div>
+
+<div class="govuk-notification-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner">
+  <div class="govuk-notification-banner__content">
+
+    <p class="govuk-notification-banner__heading">
+      Need help?
+    </p>
+      <p class="govuk-notification-banner__body">
+        The MOJ Design System Group provides support for users of the MOJ Design System. <a href="/community/help-and-feedback" class="govuk-link">Contact us</a> to ask for help.
+      </p>
+
+  </div>
+</div>
+
+<div class="govuk-!-padding-bottom-7"></div>
diff --git a/docs/_includes/layouts/partials/suggest-a-change-and-help.njk b/docs/_includes/layouts/partials/suggest-a-change-and-help.njk
@@ -0,0 +1,30 @@
+
+<hr class="govuk-section-break govuk-section-break--l govuk-section-break--visible">
+
+<div class="govuk-!-padding-bottom-3"></div>
+
+<div class="govuk-notification-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner">
+  <div class="govuk-notification-banner__content">
+  <p class="govuk-notification-banner__heading">
+    Suggest a change
+  </p>
+    <p class="govuk-notification-banner__body">
+      To help improve the MOJ Design System, you can suggest changes.
+    </p>
+    <p class="govuk-notification-banner__body">
+      Tell us about the change you're proposing by using the <a href="https://forms.gle/FpDpbgttwmfmcz8o7" class="govuk-link">suggest a change form</a>. The MOJ Design System Group will be notified of your suggestion and will review it.
+    </p>
+
+    <hr class="govuk-section-break govuk-section-break--l govuk-section-break--visible">
+
+    <p class="govuk-notification-banner__heading">
+      Need help?
+    </p>
+      <p class="govuk-notification-banner__body">
+        The MOJ Design System Group provides support for users of the MOJ Design System. <a href="/community/help-and-feedback" class="govuk-link">Contact us</a> to ask for help.
+      </p>
+
+  </div>
+</div>
+
+<div class="govuk-!-padding-bottom-7"></div>
diff --git a/docs/_includes/layouts/patterns.njk b/docs/_includes/layouts/patterns.njk
@@ -71,6 +71,8 @@
         {{ content | safe }}
       </main>
 
+        {% include "./partials/suggest-a-change-and-help.njk" %}
+
     </div>
   </div>
 {% endblock %}

diff --git a/docs/community/contribute.md b/docs/community/contribute.md
@@ -1,11 +1,11 @@
 ---
 layout: layouts/community.njk
-title: Propose a contribution
+title: Propose a component or pattern
 ---
 
-Our contribution process supports teams to add styles, components and patterns based on their users needs and service requirements, whilst guaranteeing the quality and usefulness of the MOJ Design System.
+Our contribution process supports teams to add components and patterns based on their users needs and service requirements, whilst guaranteeing the quality and usefulness of the MOJ Design System.
 
-Anyone can propose a new style, component or pattern.
+Anyone can propose a new component or pattern.
 
 ### Step 1: Check the contribution criteria
 

diff --git a/docs/community/suggest-a-change.md b/docs/community/suggest-a-change.md
@@ -0,0 +1,21 @@
+---
+layout: layouts/community.njk
+title: Suggest a change
+---
+
+To help improve the MOJ Design System, you can suggest changes to components and patterns.
+
+Useful suggestions may look like:
+
+- new research or testing that can help improve an existing component or pattern
+- reporting bugs where you've used a component or pattern in a live service and noticed an issue
+
+## Tell us your suggestion
+
+Tell us about the change you're proposing by using the [suggest a change form](https://forms.gle/FpDpbgttwmfmcz8o7). The MOJ Design System Group will be notified of your suggestion and will review it.
+
+Once reviewed, the group will either:
+
+- accept your suggestion and work to apply your change
+- accept your suggestion but work with you to tweak the changes before going ahead
+- not accept your suggestion and explain why
diff --git a/docs/index.md b/docs/index.md
@@ -7,7 +7,7 @@ title: Design, build, and deliver accessible and consistent services
 
 ## Contribute to the MOJ Design System
 
-Anyone can contribute to the MOJ Design System by proposing a new style, component, or pattern - or by suggesting a change.
+Anyone can contribute to the MOJ Design System by proposing a new style, component, or pattern.
 
 [Propose a contribution](./community/contribute)
 

diff --git a/docs/patterns/index.md b/docs/patterns/index.md
@@ -5,6 +5,8 @@ title: Patterns
 
 Patterns in this section have been created by designers and developers at MOJ.
 
+
+
 To contribute your research findings, designs or code, share it on the <a href="https://mojdt.slack.com/archives/CH5RUSB27" class="govuk-link">#moj-pattern-library-support</a> channel on Slack.</p>
 
 If a similar pattern is in the [GOV.UK Design System](https://design-system.service.gov.uk/patterns/), you should use that pattern instead.
-Original file line number
+Diff line change
@@ Expand Up / @@ -63,6 +63,8 @@ @@
             {{ content | safe }}
           </main>
+          {% include "./partials/get-help.njk" %}
         </div>
       </div>
     {% endblock %}
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,6 +5,8 @@ title: Patterns

		Patterns in this section have been created by designers and developers at MOJ.



		To contribute your research findings, designs or code, share it on the <a href="https://mojdt.slack.com/archives/CH5RUSB27" class="govuk-link">#moj-pattern-library-support</a> channel on Slack.</p>

		If a similar pattern is in the [GOV.UK Design System](https://design-system.service.gov.uk/patterns/), you should use that pattern instead.