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

New 4.7 Quick Starts focusing on the developer experience #501

Merged
merged 1 commit into from Jan 30, 2021
Merged

New 4.7 Quick Starts focusing on the developer experience #501

merged 1 commit into from Jan 30, 2021

Conversation

serenamarie125
Copy link
Contributor

@serenamarie125 serenamarie125 commented Jan 26, 2021 •
edited

Adding five (5) new Quick Starts for 4.7, which focus on the developer experience.

4 of these are available for all users:

  • Get started with Node
  • Get started with Quarkus with a Helm Chart
  • Get started with Quarkus with s2i
  • Get started with Spring Boot

1 needs special permissions:

  • Manage available content in the Helm Chart Catalog

Note: Each of these have specific icons
I've attached a screenshot of Quick Starts page with them all installed:

4 7QuickStart-MoreForTheDeveloper

Link to videos:

@serenamarie125
Copy link
Contributor Author

serenamarie125 commented Jan 26, 2021 •
edited

FYI @christianvogt @abhinandan13jan @andrewballantyne I'll add some videos in a bit. LMK if there's anything else I need to get this prioritized for review for 4.7!

FYI @sspeiche @angellk

@serenamarie125
Copy link
Contributor Author

@beaumorley please review !

@serenamarie125
Copy link
Contributor Author

@maxandersen I know you already reviewed the Quarkus Quick Starts on the test cluster today, could you comment here for awareness? I addressed all issues but the "name" of the Helm Chart. If that needs to be changed, we have to get Karena to make that change first, and we can update in a follow up

@serenamarie125
Copy link
Contributor Author

@Preeticp these Quick Starts are aligned with dev use cases, would you mind taking a quick review as well ?

@beaumorley
Copy link

beaumorley commented Jan 27, 2021 •
edited

Ran across a few issues. I looked at these Quick Starts using cluster-bot and release 4.7.0-0.nightly-2021-01-26-225405. I loaded the Quick Starts with ConsoleQuickStart.

Creat Helm Chart Repo QS:

Formatting in side panel for the steps is breaking wrong. Also when I try to paste the YAML, it pastes with no line breaks and I get an error when I try to create. See screen cap for both issues.

image

Quarkus with a Helm Chart QS:

When I click on the Quarkus v0.0.3 card from the Helm Catalog the side panel covered the Quick Start panel.

image

Also interesting that when a Helm Chart is added the side panel is automatically opened (I believe this is by design). Unfortunately, this hides the Quarkus HC. You have to scroll or close the side panel to see it.

image

Also I ran across a formatting issue in Step 3:

image

Step 4 is duplicated.

image

SpringBoot QS:

In the SpringBoot QS the icon on the card is incorrect.

image

When I added From Git I did not change the application name because the instructions did not say to. I had already added something previously so my Spring Boot deployment got added to an existing Application. So the check your work was wrong. We may want to specify to have them create the application name.

image

@andrewballantyne
Copy link
Contributor

FYI @christianvogt @abhinandan13jan @andrewballantyne I'll add some videos in a bit. LMK if there's anything else I need to get this prioritized for review for 4.7!

FYI @sspeiche @angellk

Get content sign offs from the needed stakeholders and we should be good to go @serenamarie125.

@spadgett Would you mind tossing an approve label on this? We can address the LGTM when the content is verified and good to go.
/hold

I'll hold the PR so it won't accidentally merge in the meantime.

@openshift-ci-robot openshift-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 27, 2021
@serenamarie125
Copy link
Contributor Author

@jamesfalkner please provide review !

metacosm
metacosm reviewed Jan 27, 2021
View reviewed changes
quickstarts/springboot-with-s2i.yaml Outdated
icon: >-
data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGlkPSJMYXllcl8xIiBkYXRhLW5hbWU9IkxheWVyIDEiIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiPjxkZWZzPjxzdHlsZT4uY2xzLTF7ZmlsbDojMTUzZDNjO30uY2xzLTJ7ZmlsbDojZDhkYTlkO30uY2xzLTN7ZmlsbDojNThjMGE4O30uY2xzLTR7ZmlsbDojZmZmO30uY2xzLTV7ZmlsbDojM2Q5MTkxO308L3N0eWxlPjwvZGVmcz48dGl0bGU+c25vd2Ryb3BfaWNvbl9yZ2JfZGVmYXVsdDwvdGl0bGU+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTAxMi42OSw1OTNjLTExLjEyLTM4LjA3LTMxLTczLTU5LjIxLTEwMy44LTkuNS0xMS4zLTIzLjIxLTI4LjI5LTM5LjA2LTQ3Ljk0QzgzMy41MywzNDEsNzQ1LjM3LDIzNC4xOCw2NzQsMTY4Ljk0Yy01LTUuMjYtMTAuMjYtMTAuMzEtMTUuNjUtMTUuMDdhMjQ2LjQ5LDI0Ni40OSwwLDAsMC0zNi41NS0yNi44LDE4Mi41LDE4Mi41LDAsMCwwLTIwLjMtMTEuNzcsMjAxLjUzLDIwMS41MywwLDAsMC00My4xOS0xNUExNTUuMjQsMTU1LjI0LDAsMCwwLDUyOCw5NS4yYy02Ljc2LS42OC0xMS43NC0uODEtMTQuMzktLjgxaDBsLTEuNjIsMC0xLjYyLDBhMTc3LjMsMTc3LjMsMCwwLDAtMzEuNzcsMy4zNSwyMDguMjMsMjA4LjIzLDAsMCwwLTU2LjEyLDE3LjU2LDE4MSwxODEsMCwwLDAtMjAuMjcsMTEuNzUsMjQ3LjQzLDI0Ny40MywwLDAsMC0zNi41NywyNi44MUMzNjAuMjUsMTU4LjYyLDM1NSwxNjMuNjgsMzUwLDE2OWMtNzEuMzUsNjUuMjUtMTU5LjUsMTcyLTI0MC4zOSwyNzIuMjhDOTMuNzMsNDYwLjg4LDgwLDQ3Ny44Nyw3MC41Miw0ODkuMTcsNDIuMzUsNTIwLDIyLjQzLDU1NC45LDExLjMxLDU5MywuNzIsNjI5LjIyLTEuNzMsNjY3LjY5LDQsNzA3LjMxLDE1LDc4Mi40OSw1NS43OCw4NTkuMTIsMTE4LjkzLDkyMy4wOWEyMiwyMiwwLDAsMCwxNS41OSw2LjUyaDEuODNsMS44Ny0uMzJjODEuMDYtMTMuOTEsMTEwLTc5LjU3LDE0My40OC0xNTUuNiwzLjkxLTguODgsNy45NS0xOC4wNSwxMi4yLTI3LjQzcTUuNDIsOC41NCwxMS4zOSwxNi4yM2MzMS44NSw0MC45MSw3NS4xMiw2NC42NywxMzIuMzIsNzIuNjNsMTguOCwyLjYyLDQuOTUtMTguMzNjMTMuMjYtNDkuMDcsMzUuMy05MC44NSw1MC42NC0xMTYuMTksMTUuMzQsMjUuMzQsMzcuMzgsNjcuMTIsNTAuNjQsMTE2LjE5bDUsMTguMzMsMTguOC0yLjYyYzU3LjItOCwxMDAuNDctMzEuNzIsMTMyLjMyLTcyLjYzcTYtNy42OCwxMS4zOS0xNi4yM2M0LjI1LDkuMzgsOC4yOSwxOC41NSwxMi4yLDI3LjQzLDMzLjQ5LDc2LDYyLjQyLDE0MS42OSwxNDMuNDgsMTU1LjZsMS44MS4zMWgxLjg5YTIyLDIyLDAsMCwwLDE1LjU5LTYuNTJjNjMuMTUtNjQsMTAzLjk1LTE0MC42LDExNC44OS0yMTUuNzhDMTAyNS43Myw2NjcuNjksMTAyMy4yOCw2MjkuMjIsMTAxMi42OSw1OTNaIi8+PHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMzY0LjE1LDE4NS4yM2MxNy44OS0xNi40LDM0LjctMzAuMTUsNDkuNzctNDAuMTFhMjEyLDIxMiwwLDAsMSw2NS45My0yNS43M0ExOTgsMTk4LDAsMCwxLDUxMiwxMTYuMjdhMTk2LjExLDE5Ni4xMSwwLDAsMSwzMiwzLjFjNC41LjkxLDkuMzYsMi4wNiwxNC41MywzLjUyLDYwLjQxLDIwLjQ4LDg0LjkyLDkxLjA1LTQ3LjQ0LDI0OC4wNi0yOC43NSwzNC4xMi0xNDAuNywxOTQuODQtMTg0LjY2LDI2OC40MmE2MzAuODYsNjMwLjg2LDAsMCwwLTMzLjIyLDU4LjMyQzI3Niw2NTUuMzQsMjY1LjQsNTk4LDI2NS40LDUyMC4yOSwyNjUuNCwzNDAuNjEsMzExLjY5LDI0MC43NCwzNjQuMTUsMTg1LjIzWiIvPjxwYXRoIGNsYXNzPSJjbHMtMyIgZD0iTTUyNy41NCwzODQuODNjODQuMDYtOTkuNywxMTYuMDYtMTc3LjI4LDk1LjIyLTIzMC43NCwxMS42Miw4LjY5LDI0LDE5LjIsMzcuMDYsMzEuMTMsNTIuNDgsNTUuNSw5OC43OCwxNTUuMzgsOTguNzgsMzM1LjA3LDAsNzcuNzEtMTAuNiwxMzUuMDUtMjcuNzcsMTc3LjRhNjI4LjczLDYyOC43MywwLDAsMC0zMy4yMy01OC4zMmMtMzktNjUuMjYtMTMxLjQ1LTE5OS0xNzEuOTMtMjUyLjI3QzUyNi4zMywzODYuMjksNTI3LDM4NS41Miw1MjcuNTQsMzg0LjgzWiIvPjxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTEzNC41OCw5MDguMDdoLS4wNmEuMzkuMzksMCwwLDEtLjI3LS4xMWMtMTE5LjUyLTEyMS4wNy0xNTUtMjg3LjQtNDcuNTQtNDA0LjU4LDM0LjYzLTQxLjE0LDEyMC0xNTEuNiwyMDIuNzUtMjQyLjE5LTMuMTMsNy02LjEyLDE0LjI1LTguOTIsMjEuNjktMjQuMzQsNjQuNDUtMzYuNjcsMTQ0LjMyLTM2LjY3LDIzNy40MSwwLDU2LjUzLDUuNTgsMTA2LDE2LjU5LDE0Ny4xNEEzMDcuNDksMzA3LjQ5LDAsMCwwLDI4MC45MSw3MjNDMjM3LDgxNi44OCwyMTYuOTMsODkzLjkzLDEzNC41OCw5MDguMDdaIi8+PHBhdGggY2xhc3M9ImNscy01IiBkPSJNNTgzLjQzLDgxMy43OUM1NjAuMTgsNzI3LjcyLDUxMiw2NjQuMTUsNTEyLDY2NC4xNXMtNDguMTcsNjMuNTctNzEuNDMsMTQ5LjY0Yy00OC40NS02Ljc0LTEwMC45MS0yNy41Mi0xMzUuNjYtOTEuMThhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Ny03MS41NGwuMjEtLjMyLjE5LS4zM2MzOC02My42MywxMjYuNC0xOTEuMzcsMTY3LjEyLTI0NS42Niw0MC43MSw1NC4yOCwxMjkuMSwxODIsMTY3LjEyLDI0NS42NmwuMTkuMzMuMjEuMzJhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Nyw3MS41NEM2ODQuMzQsNzg2LjI3LDYzMS44OCw4MDcuMDUsNTgzLjQzLDgxMy43OVoiLz48cGF0aCBjbGFzcz0iY2xzLTQiIGQ9Ik04ODkuNzUsOTA4YS4zOS4zOSwwLDAsMS0uMjcuMTFoLS4wNkM4MDcuMDcsODkzLjkzLDc4Nyw4MTYuODgsNzQzLjA5LDcyM2EzMDcuNDksMzA3LjQ5LDAsMCwwLDIwLjQ1LTU1LjU0YzExLTQxLjExLDE2LjU5LTkwLjYxLDE2LjU5LTE0Ny4xNCwwLTkzLjA4LTEyLjMzLTE3My0zNi42Ni0yMzcuNHEtNC4yMi0xMS4xNi04LjkzLTIxLjdjODIuNzUsOTAuNTksMTY4LjEyLDIwMS4wNSwyMDIuNzUsMjQyLjE5QzEwNDQuNzksNjIwLjU2LDEwMDkuMjcsNzg2Ljg5LDg4OS43NSw5MDhaIi8+PC9zdmc+Cg==
introduction: >-
**Spring** is a Java framework for building applications based on a distributed microservices architecture.
Copy link

Choose a reason for hiding this comment

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

Suggested change
**Spring** is a Java framework for building applications based on a distributed microservices architecture.
**Spring Boot** is a Java framework for building applications based on a distributed microservices architecture.

Also, you might want to check requirements when it comes to trademarks…

@jamesfalkner
Copy link

SpringBoot QS:

In the SpringBoot QS the icon on the card is incorrect.

Unfortunately, we can't use the upstream spring logo(s) due to commercial use trademark policy.

This logo is from the Red Hat-led Snowdrop community.

@jamesfalkner
Copy link

@jamesfalkner please provide review !

Done! I focused on the content and words and made a few suggestions.

@serenamarie125
Copy link
Contributor Author

When I click on the Quarkus v0.0.3 card from the Helm Catalog the side panel covered the Quick Start panel.
@beaumorley https://issues.redhat.com/browse/ODC-5400 was entered to capture this issue. This is a Quick Start issue, not specific to the quick start content which is part of this PR

@serenamarie125
Copy link
Contributor Author

@beaumorley

Also I ran across a formatting issue in Step 3:

This is fixed

Step 4 is duplicated.

This is fixed

In the SpringBoot QS the icon on the card is incorrect.

We are using the rh-spring-boot ( upstream snowdrop ) icon per the team's request

When I added From Git I did not change the application name because the instructions did not say to. I had already added something previously so my Spring Boot deployment got added to an existing Application. So the check your work was wrong. We may want to specify to have them create the application name.

I changed all of these to tell the user to create a new project, thus this no longer happens.

@serenamarie125
Copy link
Contributor Author

serenamarie125 commented Jan 28, 2021 •
edited

@metacosm @jamesfalkner @beaumorley all comments have been addressed!
Could you all give a lgtm if you're happy with the updates?

@angellk
Copy link

angellk commented Jan 28, 2021

lgtm

@beaumorley
Copy link

lgtm!

1 similar comment
@jamesfalkner
Copy link

lgtm!

@serenamarie125
Copy link
Contributor Author

FYI @openshift/quickstart-ux-content

Preeticp
Preeticp reviewed Jan 28, 2021
View reviewed changes
Copy link

@Preeticp Preeticp left a comment

Choose a reason for hiding this comment

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

Minor language and formatting based comments. HTH

quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/node-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/node-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/quarkus-with-helm.yaml Outdated Show resolved Hide resolved
quickstarts/quarkus-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
geoand
geoand reviewed Jan 28, 2021
View reviewed changes
quickstarts/spring-with-s2i.yaml
introduction: >-
**Spring** is a Java framework for building applications based on a distributed microservices architecture.

- Spring enables easy packaging and configuration of Spring applications into a self-contained executable application which can be easily deployed as a container to OpenShift.
Copy link

Choose a reason for hiding this comment

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

Spring enables easy packaging and configuration of Spring applications doesn't sound right

@spadgett spadgett added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 28, 2021
@spadgett
Copy link
Member

/approve

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 28, 2021
afialkoff
afialkoff suggested changes Jan 28, 2021
View reviewed changes
Copy link

@afialkoff afialkoff left a comment

Choose a reason for hiding this comment

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

Hi @serenamarie125! In this review, you'll find some general copy edits and suggestions along with a few questions about two of the quick start introductions.

Let me know if you have any questions. I hope you find this feedback useful, and I look forward to working with you more in the future! 🙂

quickstarts/manage-helm-repos.yaml Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Show resolved Hide resolved
quickstarts/manage-helm-repos.yaml Outdated

1. In the [Home navigation section]{{highlight qs-nav-home}}, click **Search**.

1. In the **Resources dropdown** on the Search page, select **HelmChartRepository**.
Copy link

Choose a reason for hiding this comment

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

Suggested change
1. In the **Resources dropdown** on the Search page, select **HelmChartRepository**.
1. Click the **Resources** dropdown menu and select **HelmChartRepository**.

quickstarts/manage-helm-repos.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
quickstarts/spring-with-s2i.yaml Outdated Show resolved Hide resolved
@serenamarie125
Copy link
Contributor Author

/retest

@beaumorley
Copy link

just reviewed all the edits. formatting looks great. ux approves.

@andrewballantyne
Copy link
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2021
@andrewballantyne
Copy link
Contributor

/hold cancel

@openshift-ci-robot openshift-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 30, 2021
@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2021
@andrewballantyne
Copy link
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2021
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewballantyne, serenamarie125, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit eebc847 into openshift:master Jan 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@metacosm metacosm metacosm left review comments

@jamesfalkner jamesfalkner jamesfalkner left review comments

@lholmquist lholmquist lholmquist left review comments

@geoand geoand geoand left review comments

@Preeticp Preeticp Preeticp left review comments

@afialkoff afialkoff afialkoff requested changes

@jhadvig jhadvig Awaiting requested review from jhadvig

@spadgett spadgett Awaiting requested review from spadgett

Assignees

@andrewballantyne andrewballantyne

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet