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

Revise the page title format for readability #1175

Open timng-bcgov opened 1 month ago

timng-bcgov commented 1 month ago

API Services Portal Issue

User Story

As an API provider or consumer ,
I want to understand the purpose of each page on the API Services Portal from the page title
so that I can configure Gateway services and consume APIs.

Test Case

ENV

TESTCASE

The <title> element defines the document's title that is shown in the browser's title bar or a page's tab.

EXPECTED

It is important to provide an accurate and concise title to describe the page's purpose. Page titles should be unique, surfacing the primary purpose of the page first, followed by the name of the website. This provides a better experience than having to read the name of a website before the unique page title, for every page a user navigates to in the same website.

Show the page title first, e.g. 'Gateway name | Gateways | API Program Services'

ACTUAL

The current title looks like this: 'API Program Services | Page'

For nested routes, the page title is easily hidden in the tab: 'API Program Services | Gateways | Gateway name'

image

Notes

There is a discrepancy between the title metadata on the API Directory as it reads 'API Services Portal | API Directory' whereas other pages on the Portal read 'API Program Services | X'. There should be a discussion on what our service(s) should be called before deciding on revising this.

Elson9 commented 1 week ago

Priority: improving UX for our services