Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create troubleshooting documentation for installing the prototype kit #45

Open
jrbarnes9 opened this issue Jul 13, 2022 · 2 comments
Open
Labels
Documentation Documentation content or feature for the prototype kit Needs validating For investigation by DS team On hold Pause working on this

Comments

@jrbarnes9
Copy link
Contributor

jrbarnes9 commented Jul 13, 2022

Background

The Design System currently has a guidance page for the ONS Prototype Kit. However, there is no guidance for troubleshooting common issues in installation and setup. For example, how to resolve build errors, console errors, conflicts and account issues. There is information available about how to contact the team if further support is needed.

We did receive feedback in a recent survey regarding this:

The prototype kit is great to use but the initial set up was painful and needed support to do so as the guidance on the Design System was not accurate

Tasks

  1. Identify the main pain points experienced by users when setting up the prototype kit
  2. Document guidance for solving the main issues experienced
  3. Possible requirement for content design to review
  4. Publish the additional guidance to the "Installing the prototype kit" section

Acceptance Criteria

We have identified the main issues users experience when installing the prototype kit and have guidance available on the ONS Prototype Kit page to resolve the most common issues.

@jrbarnes9 jrbarnes9 added the Documentation Documentation content or feature for the prototype kit label Jul 13, 2022
@jrbarnes9 jrbarnes9 mentioned this issue Jul 13, 2022
@yatesn yatesn added the Awaiting Resource Waiting for additional resource (Content Designer/Editor/UR/Tester) label Jul 22, 2022
@daniellecorke daniellecorke added the Needs validating For investigation by DS team label May 9, 2024
@daniellecorke daniellecorke changed the title Document troubleshooting Create troubleshooting documentation for the prototype kit May 10, 2024
@daniellecorke daniellecorke changed the title Create troubleshooting documentation for the prototype kit Create troubleshooting documentation for installing the prototype kit May 10, 2024
@daniellecorke daniellecorke removed the Awaiting Resource Waiting for additional resource (Content Designer/Editor/UR/Tester) label May 10, 2024
@daniellecorke
Copy link

On hold - this work is blocked by #41. When #41 is complete, we can discuss this ticket again, refine it and point it.

@MagdalenaLarge
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation content or feature for the prototype kit Needs validating For investigation by DS team On hold Pause working on this
Projects
None yet
Development

No branches or pull requests

4 participants