Skip to content

feat: customize getting started page #5707

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 12 commits into from
Oct 28, 2022
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Oct 25, 2022

Description

This adds a new CLI flag called --disable-getting-started-override which is a boolean flag and controls whether or not to use Coder's custom Getting Started page.

What's the default?

By default, we show Coder's custom Getting Started page.

How do I use the previous Getting Started page?

There are two ways to disable this new behavior:

  1. pass --disable-getting-started-override to code-server
  2. set CS_DISABLE_GETTING_STARTED_OVERRIDE=1 or CS_DISABLE_GETTING_STARTED_OVERRIDE=true

Are there tests?

Yes, for the CLI flag. No, for the feature in code-server. I decided not to because it's minor and I didn't want to increase the e2e test run time for something that wouldn't break critical userflows. I am happy to add them though if we change our minds.

Screenshot

image

And this is what it looks like when you pass --disable-getting-started-override (i.e. before this change)

image

To test locally:

  1. checkout branch, apply patches and run yarn watch
  2. command palette > "Help: Get Started"

Fixes #5661

@jsjoeio jsjoeio changed the title wip: add getting-started patch feat: customize getting started page Oct 25, 2022
@jsjoeio jsjoeio self-assigned this Oct 25, 2022
This modifies the text on the Getting Started page to promote
coder/coder.
@jsjoeio jsjoeio force-pushed the jsjoeio/update-starting-page branch from ff00339 to e241659 Compare October 25, 2022 22:02
@jsjoeio jsjoeio marked this pull request as ready for review October 25, 2022 22:03
@jsjoeio jsjoeio requested a review from a team as a code owner October 25, 2022 22:03
@jsjoeio jsjoeio temporarily deployed to npm October 25, 2022 22:17 Inactive
@github-actions
Copy link

github-actions bot commented Oct 25, 2022

✨ code-server dev build published to npm for PR #5707!

  • Last publish status: success
  • Commit: 004f02d

To install in a local project, run:

npm install @coder/code-server-pr@5707

To install globally, run:

npm install -g @coder/code-server-pr@5707

@codecov
Copy link

codecov bot commented Oct 25, 2022

Codecov Report

Merging #5707 (004f02d) into main (ca182b9) will increase coverage by 0.03%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5707      +/-   ##
==========================================
+ Coverage   72.61%   72.65%   +0.03%     
==========================================
  Files          30       30              
  Lines        1680     1682       +2     
  Branches      368      369       +1     
==========================================
+ Hits         1220     1222       +2     
  Misses        397      397              
  Partials       63       63              
Impacted Files Coverage Δ
src/node/cli.ts 91.72% <100.00%> (+0.06%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ca182b9...004f02d. Read the comment docs.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

Could you add a way to disable this message via a flag or env variable? For example, it would be quite odd to see this inside a Coder workspace.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Oct 27, 2022

Good idea! I'll convert to draft and add that.

@jsjoeio jsjoeio marked this pull request as draft October 27, 2022 17:02
This adds a new CLI flag to code-server called
`--disable-getting-started` which will be used in Code to not use
Coder's custom Getting Started text.
This modifies the getting started patch changes to work with the new
`--disable-getting-started-override`.

The flag is false by default meaning the Coder getting started is shown.
By passing the flag to code-server, it will not be shown.
@github-actions
Copy link

github-actions bot commented Oct 27, 2022

✨ code-server docs for PR #5707 is ready! It will be updated on every commit.

@jsjoeio jsjoeio marked this pull request as ready for review October 27, 2022 21:03
@jsjoeio jsjoeio requested a review from bpmct October 27, 2022 21:03
@jsjoeio jsjoeio temporarily deployed to npm October 27, 2022 21:57 Inactive
@jsjoeio jsjoeio marked this pull request as draft October 27, 2022 23:35
@jsjoeio jsjoeio marked this pull request as ready for review October 28, 2022 16:10
@repo-ranger repo-ranger bot temporarily deployed to npm October 28, 2022 16:30 Inactive
Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

LGTM!

@repo-ranger repo-ranger bot merged commit 649985a into main Oct 28, 2022
@repo-ranger repo-ranger bot deleted the jsjoeio/update-starting-page branch October 28, 2022 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feat]: Promote coder/coder in Get Started screen
2 participants