search

bcgov / api-services-portal

API Services Portal provides a multi-tenant frontend integrating API Gateway and Authorization services from Kong CE and Keycloak.
https://api.gov.bc.ca
Apache License 2.0
22 stars 7 forks source link

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

Open timng-bcgov opened 2 months ago

timng-bcgov commented 2 months ago

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

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.

rustyjux commented 2 months ago

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