Skip to content

[dashboard] Next steps nudge for local-preview #11434

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

Merged
merged 1 commit into from
Aug 2, 2022
Merged

Conversation

Pothulapati
Copy link
Contributor

@Pothulapati Pothulapati commented Jul 18, 2022

Description

Currently, After local-preview is exited There are no
direct concrete steps for users to take.

This PR fixes this by adding a new Alert box to the
global dashboard if we notice that they are on a Gitpod
local-preview DOMAIN, which is preview.gitpod-self-hosted.com
(our own DOMAIN) from now.

Signed-off-by: Tarun Pothulapati [email protected]

Signed-off-by: Tarun Pothulapati [email protected]

Related Issue(s)

Part of #11381

How to test

Run

docker run -p 443:443 --privileged --name gitpod --rm -it -v gitpod:/var/gitpod eu.gcr.io/gitpod-core-dev/build/local-preview:tar-lp-out-nudge.19

and see the nudge being present.

Release Notes

[dashboard] Next steps nudge for local-preview

Documentation

Werft options:

  • /werft with-preview

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-tar-lp-out-nudge.2 because the annotations in the pull request description changed
(with .werft/ from main)

@Pothulapati
Copy link
Contributor Author

Pothulapati commented Jul 18, 2022

/werft with-preview

👎 unknown command: with-preview
Use /werft help to list the available commands

@Pothulapati
Copy link
Contributor Author

Pothulapati commented Jul 18, 2022

/werft run

👍 started the job as gitpod-build-tar-lp-out-nudge.4
(with .werft/ from main)

@roboquat roboquat added size/S and removed size/M labels Jul 18, 2022
@Pothulapati Pothulapati changed the title [local-preview] Nudge next steps after exit [dashboard] Next steps nudge for local-preview Jul 18, 2022
@Pothulapati
Copy link
Contributor Author

Pothulapati commented Jul 18, 2022

Screenshot of what a user would see
Screenshot 2022-07-18 at 3 49 51 PM

@gtsiolis Looking forward to your feedback 👀

@Pothulapati Pothulapati marked this pull request as ready for review July 18, 2022 10:38
@Pothulapati Pothulapati requested a review from a team July 18, 2022 10:38
@gtsiolis gtsiolis requested a review from a team July 18, 2022 10:38
@github-actions github-actions bot added team: webapp Issue belongs to the WebApp team team: product-design labels Jul 18, 2022
@gtsiolis
Copy link
Contributor

gtsiolis commented Jul 18, 2022

Looking at this now! 👀

Copy link
Contributor

@gtsiolis gtsiolis left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up, @Pothulapati! 🔮

Left one issue below to make this UX ready, and one suggestion for updating the copy.

Approving to unblock merging but holding to let someone from the @gitpod-io/engineering-webapp take a closer look at the code changes.

/hold

@@ -489,6 +493,18 @@ export default function Menu() {
))}
</nav>
)}
{isLP && (
Copy link
Contributor

Choose a reason for hiding this comment

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

issue: Not sure where can we move this piece of code, but the alert component component should be placed below the top navigation bar, including the tabs and above the pager heading. The current placement is breaking the layout in some pages.

BEFORE AFTER
Screenshot 2022-07-18 at 6 13 55 PM (2) Screenshot 2022-07-18 at 6 17 16 PM (2)
Screenshot 2022-07-18 at 6 57 40 PM (2) Screenshot 2022-07-18 at 6 57 32 PM (2)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gtsiolis Can you take a look on this layout issue?

I've moved this into App.tsx where the new AppNotifications are, and you can access the instance at https://tar-lp-out-nudge.preview.gitpod-dev.com/workspaces

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks great, @Pothulapati! Two minor issues:

  1. Grid: We're using a page container with a fixed layout for our grid layout. Using this approach the ideal maximum width of the page container should follow the fixed width of the page container.
  2. Spacing: We've been using an 8-point grid system with spacing scale to help us provide all the negative area needed between elements and components, see relevant discussion (internal). Every part of the user interface should be intentional about empty space between elements. The amount of space between items creates relationships and hierarchy. For example, 8px is used to separate related elements while 16px is used to separate unrelated elements.

Cc @gitpod-io/engineering-self-hosted for visibility and future reference.

One interesting point we may run into the future could be to see how this alert stacks with more global alerts coming through the AppNotifications.txt, which could be fine as long as we limit the amount of alerts we stack, but I'd assume there's little to zero changes of running into more alerts here as the local preview is not intended for production use.

To get back to the actual UX changes, using a parent div container for the alert with two classes (app-container and mt-2) should make all the necessary changes here. 🍵

BEFORE AFTER
Screenshot 2022-08-01 at 3 56 30 PM Screenshot 2022-08-01 at 3 56 25 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'd assume there's little to zero changes of running into more alerts here as the local preview is not intended for production use.

Exactly, and hence my reason for not using AppNotifications.

@stale
Copy link

stale bot commented Jul 30, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the meta: stale This issue/PR is stale and will be closed soon label Jul 30, 2022
@Pothulapati Pothulapati requested a review from a team August 1, 2022 06:19
@roboquat roboquat added size/M and removed size/S labels Aug 1, 2022
@stale stale bot removed the meta: stale This issue/PR is stale and will be closed soon label Aug 1, 2022
@Pothulapati Pothulapati force-pushed the tar/lp-out-nudge branch 2 times, most recently from 62e305d to 01c1175 Compare August 1, 2022 10:06
@andrew-farries andrew-farries self-assigned this Aug 2, 2022
Currently, After `local-preview` is exited There are no
direct concrete steps for users to take.

This PR fixes this by adding a new `Alert` box to the
global dashboard if we notice that they are on a Gitpod
`local-preview` DOMAIN, which is `preview.gitpod-self-hosted.com`
(our own DOMAIN) from now.

Signed-off-by: Tarun Pothulapati <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployed: webapp Meta team change is running in production release-note size/M team: product-design team: webapp Issue belongs to the WebApp team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants