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

feat(quickstarts/tour): add Cryostat guided tour and various QuickStarts #910

Merged
merged 21 commits into from
Apr 3, 2023

Conversation

maxcao13
Copy link
Member

@maxcao13 maxcao13 commented Mar 16, 2023

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: #902
Closes: #880

Description of the change:

Adds a guided tour to Cryostat, similar to what Openshift does and adds 4? new quickstarts. These quickstarts and guide can be found under the (?) help button.

How to manually test:

Run normally and try each of these components out.
image

@github-actions github-actions bot added the needs-triage Needs thorough attention from code reviewers label Mar 16, 2023
@mergify mergify bot added the safe-to-test label Mar 16, 2023
@maxcao13 maxcao13 force-pushed the quickstarts/react-joyride branch from 0c3eba9 to ebcac8b Compare March 21, 2023 17:58
@maxcao13 maxcao13 added feat New feature or request and removed needs-triage Needs thorough attention from code reviewers labels Mar 21, 2023
@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-ebcac8b83c9efddc36968d6f8fa91b54447ed325 sh smoketest.sh

@maxcao13 maxcao13 force-pushed the quickstarts/react-joyride branch from ebcac8b to 605940b Compare March 23, 2023 03:52
@maxcao13 maxcao13 marked this pull request as ready for review March 23, 2023 03:54
@maxcao13 maxcao13 requested a review from tthvo March 23, 2023 03:54
@maxcao13
Copy link
Member Author

Should be ready for light review, settings quickstart could use extra work, and dashboard quick start has been started yet.

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-ce3cb9dd1af306391b8ec90bdc84d90f11d51448 sh smoketest.sh

@andrewazores
Copy link
Member

Awesome. The tour currently misses Automated Rules and Events nav items, I think those should be covered too. Events should be pretty brief to summarize, and Automated Rules doesn't need too much explanation here since there is also a quickstart for it that explains it in depth (also nice).

@tthvo
Copy link
Member

tthvo commented Mar 23, 2023

Looks amazing! I am blown away :D Just a notice that some references to an element is not working (maybe the element is lacking the data-highlight props). For example, the event template selector in Automated Rules. We might also have to check collapsed navigation sidecar and actions overflow button in Recording table.

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-166eca6b76f7037b1f79b7e75ccaafed8f8ee538 sh smoketest.sh

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-d2c0ad1d4a7c7371d2a871f5e67027c00af691e5 sh smoketest.sh

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-b932b3e91c67caf51ab214f4b7403e73b0ec14da sh smoketest.sh

@andrewazores
Copy link
Member

image

allow you start recordings on a target JVM

I think this should be pluralized: "allow you to start recordings on target JVMs based on sets of conditions"

image

Any particular reason for calling out reports here? Reports can also be generated on the Recordings and Dashboards views, after all.

image

The Events page lists the Event Templates that Cryostat can currently apply to a JFR recording. It also lists Event Types that are available on the target JVM.

"The Events page lists the Event Templates that can be used for creating Flight Recordings. It also details the JFR Event Types that can be recorded within each target JVM."

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-81924c2488bae5db2eabe339addf33095d4d4e26 sh smoketest.sh

@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-96799e6d196bd08adbeb46b862223228cc9ba83b sh smoketest.sh

README.md Outdated Show resolved Hide resolved
src/app/assets/palette.svg Outdated Show resolved Hide resolved
src/app/app.css Outdated Show resolved Hide resolved
Copy link
Member

@tthvo tthvo left a comment

Choose a reason for hiding this comment

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

Implementations and contents look good to me! Leaving to Andrew for finalizing contents :))

@andrewazores
Copy link
Member

One last little nitpick: please remove mentions of the word "upstream", and wherever this is referring to some URL, please ensure that URL is provided by the build.json file rather than hardcoded into the sources.

@maxcao13 maxcao13 force-pushed the quickstarts/react-joyride branch from a8ea514 to 407aa17 Compare March 31, 2023 06:17
@github-actions
Copy link

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-407aa17ecb01a6db097824580d407931318e6e3f sh smoketest.sh

@github-actions
Copy link

github-actions bot commented Apr 3, 2023

Test image available:

CRYOSTAT_IMAGE=ghcr.io/cryostatio/cryostat-web:pr-910-57b9b46935fbce785ab41fda52d1c4aa1c4444fd sh smoketest.sh

@andrewazores andrewazores merged commit d817ee2 into cryostatio:main Apr 3, 2023
@maxcao13 maxcao13 deleted the quickstarts/react-joyride branch April 3, 2023 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or request safe-to-test
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Task] Add various QuickStarts for Cryostat [Story] Cryostat in-app guidance and tutorials
3 participants