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.

Sign up for GitHub

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

Jump to bottom

feat(joyride): show guided tour upon cryostat upgrades #971

Merged
merged 3 commits into from
Apr 22, 2023
Merged

feat(joyride): show guided tour upon cryostat upgrades #971

merged 3 commits into from
Apr 22, 2023

Conversation

tthvo
Copy link
Member

@tthvo tthvo commented Apr 19, 2023 •
edited
Loading

Welcome to Cryostat! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed the last commit: git commit --amend --signoff

Fixes: #970

Description of the change:

Add a hint banner for app layout. This checks a local storage key to see if it should show or not. Only showed when logged in.

Motivation for the change:

See #970

@tthvo tthvo added chore Refactor, rename, cleanup, etc. feat New feature or request labels Apr 19, 2023
@tthvo tthvo requested review from andrewazores and maxcao13 April 19, 2023 21:56
@mergify mergify bot added the safe-to-test label Apr 19, 2023
@tthvo
Copy link
Member Author

tthvo commented Apr 19, 2023 •
edited
Loading

What do u think? Let me know if u want a different message or close banner (won't show again) if the users follow the link :))

If good, we can backport this.

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-255b30ed55ba8976311035d76c442793ecc8499c sh smoketest.sh

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-d0415c58a53be1ab01aa6becfab210dba0baa175 sh smoketest.sh

@maxcao13
Copy link
Member

Looks great! Should the banner be closed when users click the link as well?

Also I think the link should be quick starts instead of quickstarts?

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-45ab6384f398a4236b23cd1af00152014599ac7f sh smoketest.sh

@tthvo tthvo mentioned this pull request Apr 20, 2023
Closed
@tthvo
Copy link
Member Author

tthvo commented Apr 20, 2023

@andrewazores How about now? I added a local storage key to keep track of Cryostat front-end asset version. If the build version is higher than one saved in local storage, it will show the tour (includes step 8/9 talking about quickstarts).

Was trying to use semver package but ran into this issue: npm/node-semver#554. So, I just wrote a simple replacement that expects a complete semver (major-minor-patch) (this also helps reducing bundle size): https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-8afc9cae9dfe435eec38578f7c36a88d3da527c8 sh smoketest.sh

@tthvo tthvo changed the title feat(quickstarts): notify users about available quickstarts feat(joyride): show guided tour upon cryostat upgrades Apr 20, 2023
@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-8afc9cae9dfe435eec38578f7c36a88d3da527c8 sh smoketest.sh

@andrewazores
Copy link
Member

Looks great.

image

Might be nice to put that new version string on this modal? "Welcome to Cryostat 2.3.0!"

@andrewazores
Copy link
Member

^ That version string should probably also be present on the AboutModal.

@tthvo
Copy link
Member Author

tthvo commented Apr 21, 2023 •
edited
Loading

Guided Tour About Modal
Screenshot from 2023-04-20 23-43-25 Screenshot from 2023-04-20 23-43-09

@tthvo
Copy link
Member Author

tthvo commented Apr 21, 2023

The version field in the about modal is off due to #882. Are we planning a fix for that for this release?

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-71ea21b4e978b46fd61c169758acb04a9dee21f5 sh smoketest.sh

@andrewazores
Copy link
Member

The version field in the about modal is off due to #882. Are we planning a fix for that for this release?

I'll take a look at it again. I think Max was probably right and simply tagging the main branch at the same place as the release branchpoint would probably fix it. If so, that's pretty simple and easy.

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-971-ea88a22e6d264d97442af73c2343d50c70299aac sh smoketest.sh

@andrewazores
Copy link
Member

andrewazores commented Apr 21, 2023 •
edited
Loading

The version field in the about modal is off due to #882. Are we planning a fix for that for this release?

I'll take a look at it again. I think Max was probably right and simply tagging the main branch at the same place as the release branchpoint would probably fix it. If so, that's pretty simple and easy.

On current main:

image

On current cryostat-v2.3:

image

(I think it's -dirty because I forgot to git submodule update before this, so there are "unstaged changes" because of that)

Looks right. All I did was tag the last common commit before your branch separation commit as the v2.3.0 branchpoint. When it comes time to cut the 2.3.0 release for GA, I'll need to create another tag at at "end" of the cryostat-v2.3 branch to associate with the release version, so I'll probably call that one v2.3.0-ga or something. This should only affect the appearance of that string in the UI basically - the image tag versions come from the pom.xml, the GitHub release version is manually set, so I think changing the format a little like this is harmless.

Or maybe the tag I just created as v2.3.0 should instead be v2.3.0-pre or something like that? @ebaron any opinion?

@tthvo tthvo mentioned this pull request Apr 21, 2023
Merged
7 tasks
@andrewazores andrewazores merged commit f817123 into cryostatio:main Apr 22, 2023
mergify bot pushed a commit that referenced this pull request Apr 22, 2023
@mergify
feat(joyride): show guided tour upon cryostat upgrades (#971)
4af88d8 
* chore(comp): remove unused hint banner

* feat(joyride): check asset version

* chore(version): display cryostat version

(cherry picked from commit f817123)
@mergify mergify bot mentioned this pull request Apr 22, 2023
Merged
andrewazores pushed a commit that referenced this pull request Apr 22, 2023
@mergify
feat(joyride): show guided tour upon cryostat upgrades (#971) (#975)
23a8146 
* chore(comp): remove unused hint banner

* feat(joyride): check asset version

* chore(version): display cryostat version

(cherry picked from commit f817123)

Co-authored-by: Thuan Vo <thvo@redhat.com>
@tthvo tthvo deleted the hint-banner branch April 22, 2023 19:05
@andrewazores andrewazores mentioned this pull request Apr 25, 2023
Closed
@tthvo tthvo mentioned this pull request Aug 10, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewazores andrewazores andrewazores approved these changes

@maxcao13 maxcao13 Awaiting requested review from maxcao13

Assignees
No one assigned
Labels
backport chore Refactor, rename, cleanup, etc. feat New feature or request safe-to-test
Projects
No open projects
2.3.0 release
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Request] Notify users about available quickstarts if any
3 participants
@tthvo @maxcao13 @andrewazores