From 421c4bb00f47cd036e3d86fe113fd14e5c494135 Mon Sep 17 00:00:00 2001 From: Rob McCarthy <56701345+robertjmccarthy@users.noreply.github.com> Date: Fri, 17 Nov 2023 15:50:21 +0000 Subject: [PATCH] docs(suggest a change): adding information and way for users to suggest 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 --------- Co-authored-by: Greg Tyler --- docs/_includes/layouts/community.njk | 8 ++++- docs/_includes/layouts/component.njk | 1 + docs/_includes/layouts/get-started.njk | 2 ++ .../layouts/partials/contact-panel.njk | 6 ---- docs/_includes/layouts/partials/get-help.njk | 19 ++++++++++++ .../partials/suggest-a-change-and-help.njk | 30 +++++++++++++++++++ docs/_includes/layouts/patterns.njk | 2 ++ docs/community/contribute.md | 6 ++-- docs/community/suggest-a-change.md | 21 +++++++++++++ docs/index.md | 2 +- docs/patterns/index.md | 2 ++ 11 files changed, 88 insertions(+), 11 deletions(-) delete mode 100644 docs/_includes/layouts/partials/contact-panel.njk create mode 100644 docs/_includes/layouts/partials/get-help.njk create mode 100644 docs/_includes/layouts/partials/suggest-a-change-and-help.njk create mode 100644 docs/community/suggest-a-change.md diff --git a/docs/_includes/layouts/community.njk b/docs/_includes/layouts/community.njk index 6f8b7b93..6827f2a5 100644 --- 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 }} + {% include "./partials/get-help.njk" %} + {% endblock %} diff --git a/docs/_includes/layouts/component.njk b/docs/_includes/layouts/component.njk index 8a5e74dd..77256794 100644 --- a/docs/_includes/layouts/component.njk +++ b/docs/_includes/layouts/component.njk @@ -154,6 +154,7 @@ {{ content | safe }} + {% include "./partials/suggest-a-change-and-help.njk" %} {% endblock %} diff --git a/docs/_includes/layouts/get-started.njk b/docs/_includes/layouts/get-started.njk index 2a7f8d54..67bfdbc0 100644 --- a/docs/_includes/layouts/get-started.njk +++ b/docs/_includes/layouts/get-started.njk @@ -63,6 +63,8 @@ {{ content | safe }} + {% include "./partials/get-help.njk" %} + {% endblock %} diff --git a/docs/_includes/layouts/partials/contact-panel.njk b/docs/_includes/layouts/partials/contact-panel.njk deleted file mode 100644 index 93a3b7cd..00000000 --- a/docs/_includes/layouts/partials/contact-panel.njk +++ /dev/null @@ -1,6 +0,0 @@ - -
-

Need help?

-

If you have any questions, send a message to the #moj-design-system-support channel on Slack and a member of the MOJ Design System Group will be able to help.

- -
diff --git a/docs/_includes/layouts/partials/get-help.njk b/docs/_includes/layouts/partials/get-help.njk new file mode 100644 index 00000000..69882091 --- /dev/null +++ b/docs/_includes/layouts/partials/get-help.njk @@ -0,0 +1,19 @@ + +
+ +
+ +
+
+ +

+ Need help? +

+

+ The MOJ Design System Group provides support for users of the MOJ Design System. Contact us to ask for help. +

+ +
+
+ +
diff --git a/docs/_includes/layouts/partials/suggest-a-change-and-help.njk b/docs/_includes/layouts/partials/suggest-a-change-and-help.njk new file mode 100644 index 00000000..b9357eb5 --- /dev/null +++ b/docs/_includes/layouts/partials/suggest-a-change-and-help.njk @@ -0,0 +1,30 @@ + +
+ +
+ +
+
+

+ Suggest a change +

+

+ To help improve the MOJ Design System, you can suggest changes. +

+

+ Tell us about the change you're proposing by using the suggest a change form. The MOJ Design System Group will be notified of your suggestion and will review it. +

+ +
+ +

+ Need help? +

+

+ The MOJ Design System Group provides support for users of the MOJ Design System. Contact us to ask for help. +

+ +
+
+ +
diff --git a/docs/_includes/layouts/patterns.njk b/docs/_includes/layouts/patterns.njk index ed7cc40b..172f3d03 100644 --- a/docs/_includes/layouts/patterns.njk +++ b/docs/_includes/layouts/patterns.njk @@ -71,6 +71,8 @@ {{ content | safe }} + {% include "./partials/suggest-a-change-and-help.njk" %} + {% endblock %} diff --git a/docs/community/contribute.md b/docs/community/contribute.md index 17ec48da..3a7f89e4 100644 --- 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 new file mode 100644 index 00000000..fed18868 --- /dev/null +++ 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 index e86d8830..194628d5 100644 --- 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 index 7be1e844..2f4f6550 100644 --- 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 #moj-pattern-library-support channel on Slack.

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