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

Provide more context for command line actions on the Get started page #1168

Open
2 of 3 tasks
timng-bcgov opened this issue Sep 6, 2024 · 1 comment
Open
2 of 3 tasks
Labels
jira ux User experience

Comments

@timng-bcgov
Copy link

timng-bcgov commented Sep 6, 2024

Priority

Low

User Story

As an API provider ,

I want to understand the prerequisites and results of actions I take when following the Get started tutorial

so that I can learn how to create and configure Gateway services.

Test Case

ENV

  • DEV
  • TEST
  • PROD

TESTCASE

Navigate to the "Steps to create and configure your first Gateway" section on the Get started page on the Services Portal: https://api-gov-bc-ca.dev.api.gov.bc.ca/manager/gateways/get-started

EXPECTED

Additional context and expected results are provided for each command line code block. Refer to the DevHub Quick start tutorial for examples. Requires further discussion with the team as to the level of detail that should be included.

ACTUAL

Limited context is provided for each command line code block.

Notes

We received feedback during ns-to-gw user acceptance testing that users enjoyed the style and layout of the Get started page, but would like to see more detailed information akin to the Quick start tutorial.

I recall one of the previous design files included a button that brought up video examples executing the command line code, but I wasn't able to find it in the current Figma file. I will look a bit closer but we should discuss feasibility of incorporating this as it might benefit users onboarding to our service.

@timng-bcgov timng-bcgov added ux User experience jira enhancement New feature or request and removed enhancement New feature or request labels Sep 6, 2024
@rustyjux
Copy link
Contributor

rustyjux commented Sep 9, 2024

For many (or all?) of the commands I think a GIF would be totally adequate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira ux User experience
Projects
None yet
Development

No branches or pull requests

2 participants