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

fix: UI titles and message consistency #3502

Merged
merged 8 commits into from
May 28, 2024

Conversation

balhar-jakub
Copy link
Member

Description

Make the messages consistent
Add UI titles explaining error, warning and success.

Linked to #3458 and #3456

Type of change

  • fix: Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code follows the style guidelines of this project
  • PR title conforms to commit message guideline ## Commit Message Structure Guideline
  • I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • The java tests in the area I was working on leverage @nested annotations
  • Any dependent changes have been merged and published in downstream modules

For more details about how should the code look like read the Contributing guideline

Signed-off-by: Jakub Balhar <jakub@balhar.net>
Add title explaining the state

Signed-off-by: Jakub Balhar <jakub@balhar.net>
@balhar-jakub
Copy link
Member Author

balhar-jakub commented Apr 9, 2024

@dkelosky Can you please help me refine the messages that should be shown as titles?

Screenshot 2024-04-09 at 13 11 53
Screenshot 2024-04-09 at 13 11 59
Screenshot 2024-04-09 at 13 12 54

@balhar-jakub
Copy link
Member Author

@dkelosky Is there any update from your side on the messaging or should we rather integrate this change and then take a look on further improvements later?

@dkelosky
Copy link
Contributor

Sorry for the delay - I reached out to some UX/UI friends for help. I will post back after getting their help. There were issues:

  • consistently adding "Service" after each service (with proper capitalization)
  • matching startup WTO of services with UI list of services (authentication service is not in startup WTO, gateway service is not in UI)
  • insight into API ML status if I have a mix of green, yellow, and red statuses
  • The API Catalog Is Running is a hyperlink which links to login page - perhaps it is not intuitive that this hyperlink is how you access the catalog.

@balhar-jakub
Copy link
Member Author

This PR solves only the first and third issue, the rest isn't touched by this PR.

@balhar-jakub
Copy link
Member Author

@dkelosky Any update?

@dkelosky
Copy link
Contributor

No updated - I engaged a friend (internally) to get some input. Will update back here once I get a response.

Copy link
Contributor

@janan07 janan07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed by doc squad

Signed-off-by: Andrew Jandacek <andrew.jandacek@broadcom.com>
Copy link

sonarcloud bot commented May 28, 2024

@balhar-jakub balhar-jakub merged commit bcf992d into v2.x.x May 28, 2024
31 checks passed
@delete-merged-branch delete-merged-branch bot deleted the balhar-jakub/GH3458/gateway-ui branch May 28, 2024 15:00
Shobhajayanna pushed a commit that referenced this pull request Jun 19, 2024
Signed-off-by: sj895092 <shobhackm9@gmail.com>
@Shobhajayanna Shobhajayanna mentioned this pull request Jun 19, 2024
10 tasks
Shobhajayanna added a commit that referenced this pull request Jun 20, 2024
* fix: UI titles and message consistency (#3502)

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* add bootRun debug default options (#3595)

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* attempt at fixing flaky test (#3596)

Signed-off-by: Pablo Hernán Carle <pablo.carle@broadcom.com>
Co-authored-by: Pablo Hernán Carle <pablo.carle@broadcom.com>

* update working dir in bootrun task (#3602)

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* removed metrics service related test

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* chore: protect conformance endpoints and add them to Swagger (#3604)

* protect endpoints

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* add conformance to swagger

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* add test

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

---------

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* chore: protect conformance endpoints and add them to Swagger (#3604)

* protect endpoints

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* add conformance to swagger

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* add test

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

---------

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* removing metric service reference

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* removing gateway changes from v2 cherry pick

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* reverting back changes in gateway service

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* reverting back changes in gateway service

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* reverting back conformance endpoint validation changes

Signed-off-by: sj895092 <shobhackm9@gmail.com>

* reverting back conformance endpoint validation changes

Signed-off-by: sj895092 <shobhackm9@gmail.com>

---------

Signed-off-by: sj895092 <shobhackm9@gmail.com>
Signed-off-by: Pablo Hernán Carle <pablo.carle@broadcom.com>
Signed-off-by: at670475 <andrea.tabone@broadcom.com>
Co-authored-by: Jakub Balhar <jakub@balhar.net>
Co-authored-by: Pablo Carle <pablocarle@users.noreply.github.com>
Co-authored-by: Pablo Hernán Carle <pablo.carle@broadcom.com>
Co-authored-by: Andrea Tabone <39694626+taban03@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants