Skip to content

Adjusting onboarding copy for better readability #16570

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 2 commits into from
Feb 27, 2023

Conversation

selfcontained
Copy link
Contributor

@selfcontained selfcontained commented Feb 24, 2023

Description

Adjusting some of the copy on the final step of onboarding to help readability.

I work in... Overview
image image

How to test

Release Notes

NONE

Documentation

Build Options:

  • /werft with-github-actions
    Experimental feature to run the build with GitHub Actions (and not in Werft).
  • leeway-no-cache
    leeway-target=components:all
  • /werft no-test
    Run Leeway with --dont-test
Publish Options
  • /werft publish-to-npm
  • /werft publish-to-jb-marketplace
Installer Options
  • with-ee-license
  • with-slow-database
  • with-dedicated-emulation
  • with-ws-manager-mk2
  • workspace-feature-flags
    Add desired feature flags to the end of the line above, space separated

Preview Environment Options:

  • /werft with-local-preview
    If enabled this will build install/preview
  • /werft with-preview
  • /werft with-large-vm
  • /werft with-gce-vm
    If enabled this will create the environment on GCE infra
  • /werft with-integration-tests=all
    Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-bmh-onboarding-copy-updates.1 because the annotations in the pull request description changed
(with .werft/ from main)

@selfcontained selfcontained changed the title adjusting copy for better readability Adjusting onboarding copy for better readability Feb 24, 2023
@selfcontained selfcontained marked this pull request as ready for review February 24, 2023 22:54
@selfcontained selfcontained requested a review from a team February 24, 2023 22:54
@github-actions github-actions bot added the team: webapp Issue belongs to the WebApp team label Feb 24, 2023
@selfcontained
Copy link
Contributor Author

selfcontained commented Feb 24, 2023

/werft run with-preview=true

👍 started the job as gitpod-build-bmh-onboarding-copy-updates.2
(with .werft/ from main)

Copy link
Member

@easyCZ easyCZ left a comment

Choose a reason for hiding this comment

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

LGTM

/hold in case you want feedback from design

@@ -169,7 +169,7 @@ export const StepOrgInfo: FC<Props> = ({ user, onComplete }) => {
<TextInputField
value={jobRoleOther}
onChange={setJobRoleOther}
placeholder="Please specify"
placeholder="Please share (optional)"
hint={
jobRole === JOB_ROLE_OTHER
? "Please select the role that best describes the type of work you'll use Gitpod for"
Copy link
Member

@loujaybee loujaybee Feb 27, 2023

Choose a reason for hiding this comment

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

Suggestion (non-blocking): I'd suggest to remove this help text, as I don't see what additional context it provides a user.


If we do decide to keep, I'd suggest to remove the "work you'll use Gitpod for", part as:

  • User likely doesn't really know what Gitpod is
  • We have the other field later on for the purpose
Suggested change
? "Please select the role that best describes the type of work you'll use Gitpod for"
? "Please select the role which best describes your profession"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, I'll drop the hint completely from this.

{ value: "team-lead", label: "Team / Function Lead" },
{ value: "academics", label: "Academia (Student, Researcher)" },
{ value: "enabling", label: "Platform or Developer Experience" },
{ value: "team-lead", label: "A Team or Function Lead role" },
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion(non-blocking): Could we add "lead" after team lead? I noticed some people submitted "team lead" in other, but did not notice here, my theory is because we say "team / function lead" so on scanning "team lead" does not appear.

Suggested change
{ value: "team-lead", label: "A Team or Function Lead role" },
{ value: "team-lead", label: "A Team Lead or Function Lead role" },

Copy link
Member

@loujaybee loujaybee 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 the clean up changes, Brad ! 🙏

@selfcontained
Copy link
Contributor Author

selfcontained commented Feb 27, 2023

/werft run with-preview=true

👍 started the job as gitpod-build-bmh-onboarding-copy-updates.3
(with .werft/ from main)

@selfcontained selfcontained force-pushed the bmh/onboarding-copy-updates branch from d6e4416 to c4b306b Compare February 27, 2023 16:38
@roboquat roboquat added size/M and removed size/S labels Feb 27, 2023
@selfcontained
Copy link
Contributor Author

/unhold

@roboquat roboquat merged commit 1d7c01e into main Feb 27, 2023
@roboquat roboquat deleted the bmh/onboarding-copy-updates branch February 27, 2023 16:47
@roboquat roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Mar 1, 2023
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 deployed Change is completely running in production release-note-none size/M team: webapp Issue belongs to the WebApp team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants