-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
Conversation
This modifies the text on the Getting Started page to promote coder/coder.
ff00339
to
e241659
Compare
Codecov Report
Additional details and impacted files@@ 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
Continue to review full report at Codecov.
|
There was a problem hiding this 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.
Good idea! I'll convert to draft and add that. |
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.
✨ code-server docs for PR #5707 is ready! It will be updated on every commit.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Description
This adds a new CLI flag called
--disable-getting-started-override
which is aboolean
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:
--disable-getting-started-override
tocode-server
CS_DISABLE_GETTING_STARTED_OVERRIDE=1
orCS_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
And this is what it looks like when you pass
--disable-getting-started-override
(i.e. before this change)To test locally:
yarn watch
Fixes #5661