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

Revise page naming / headings ('My' / 'Your') #1143

Open
rustyjux opened this issue Aug 19, 2024 · 8 comments
Open

Revise page naming / headings ('My' / 'Your') #1143

rustyjux opened this issue Aug 19, 2024 · 8 comments
Labels
jira ux User experience

Comments

@rustyjux
Copy link
Contributor

rustyjux commented Aug 19, 2024

API Services Portal Issue

User Story

As an API provider,

I want consistent naming conventions

so that I can more easily find/understand a given page.

Review page names / headings for consistency.

Current Suggested change
Page URL Nav Button Page Heading
/devportal/api-directory/your-products Your Products Your Products --> My Products (or something else to indicate it's the preview page like Products Preview or Directory Preview)
/manager/services Gateway Services Gateway Services ?
/manager/products Products Products ?
/manager/consumers Consumers Consumers ?
/devportal/access My Access My Access None
/devportal/applications Applications My Applications ?
/manager/gateways/list Gateways My Gateways ?
/manager/gateways/get-started N/A My Gateways ?
@rustyjux rustyjux added ux User experience jira labels Aug 19, 2024
@rustyjux
Copy link
Contributor Author

@timng-bcgov following up from our chat

@timng-bcgov
Copy link

timng-bcgov commented Aug 19, 2024

My thoughts right now:

  • "My Products" sounds good
  • Leave "Gateway Services", "Products", and "Consumers" as-is, because the breadcrumbs already indicate "My Gateways > Gateway name > X"
  • The headings should be consistent between Access, Applications, and Gateways. I am leaning towards renaming the tabs to include "My", so "Applications" and "Gateways" should be updated to "My Applications" and "My Gateways"

@ikethecoder
Copy link
Member

My view is to drop "My" all together.. perhaps change "My Access" to "API Access", and then just refer to "Applications" and "Gateways" as just that. Because Gateways are not exclusively mine - I just have access to them. And Applications are moving in that direction too with the "Application Sharing". When I think of "My XXX" I think that it's exclusively mine.

Then for the API Directory "My Products" - perhaps "Gateway Products"?

@rustyjux
Copy link
Contributor Author

I like Aidan's future-looking suggestion - Gateways (and soon Applications) can be shared, so cut 'My' across the board.

'Your Products':

Some facts about the 'Your Products' page:

  • from the page itself: 'A list of the published and unpublished products under your gateway.'
  • it shows the Datasets (containing Products) for Products in the current Gateway
  • it allows users to preview how their Datasets/Products will look in the API Directory
  • it also includes published Datasets (ie enabled Product Environments)

For me, Aidan's suggestion of "Gateway Products" isn't clearly saying 'Products in this Gateway'. When I hear that, I instead start to think about Gateway Services. Not sure if that is the right association we are going for?

A name like 'Directory Preview' is reductive and inaccurate (since it includes published stuff too).

Products in Gateway? Products in ?

Other candidates?

@Elson9
Copy link
Contributor

Elson9 commented Aug 19, 2024

Products in <gw display name> seems the most clear to me

@rustyjux
Copy link
Contributor Author

My qualm with that option is it provides a less consistent appearance in the nav and makes the page harder to refer to in docs.

@timng-bcgov
Copy link

I think "Products in Gateway" makes sense because the display name is already shown below it:

image

@rustyjux
Copy link
Contributor Author

Riiight. That header design is flexible btw - it wasn't in the Figma so I just modeled it after the Gateway details page. Looking at prod, I think it would help to add 'Products' back to the heading to give <displayName> Products.

For page name, I'm good with 'Products in Gateway'. Or 'Gateway Products' if that jives better for folks.

I don't think these changes need to get pushed into the NS to GW release but the updates would be quick across Portal and docs once we have some decisions.

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

4 participants