-
Notifications
You must be signed in to change notification settings - Fork 5.9k
New flags readme #422
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
New flags readme #422
Conversation
… configuration options, update bug template to direct ide.coder.com issues to the correct place.
doc/self-hosted/index.md
Outdated
``` | ||
### Extension Directory | ||
Point code-server at a local directory with installed extensions. This allows inheriting local VSCode extensions by specifying `--extensions-dir ~/.vscode/extensions` |
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.
Feels a bit difficult to parse this. Maybe:
Specify a custom directory for extensions. Provides compatibility with local VS Code extensions by specifying `--extensions-dir ~/.vscode/extensions`.
doc/self-hosted/index.md
Outdated
|
||
### Data Directory | ||
### User Data Directory | ||
Specify the root folder that VS Code will start in. This allows inheriting local VS Code configuration. Example `--user-data-dir ~/.config/User` |
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.
Maybe:
Specify where data is stored. Provides compatibility with local VS Code configuration by specifying `--user-data-dir ~/.config/User`.
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.
I realize this is correct for Linux, but for mac (at least on my installation), the local VS Code configuration is stored in --user-data-dir ~/Library/Application\ Support/Code/
It'd be nice to list both.
README.md
Outdated
@@ -50,6 +50,9 @@ Quickstart guides for [Google Cloud](doc/admin/install/google_cloud.md), [AWS](d | |||
|
|||
How to [secure your setup](/doc/security/ssl.md). | |||
|
|||
### Customize User Data | |||
- Use your local VSCode configuration and locally installed extensions with the `--user-data-dir` and `--extensions-dir` flags. View the [quick start](doc/self-hosted/index.md) guide for more. |
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.
Maybe:
Use VS Code Data
Use your existing VS Code configuration and extensions using the --user-data-dir
and --extensions-dir
flags. View the quick start guide for more.
The readme has the "-h" flag twice. First for (-h, --host) and second for (-h, --help) causing a conflict as -h will never trigger for the help menu. This conflict is also found in the latest release. |
Just noticed doc/self-hosted/index.md also mentions the code-server -h help option at bottom. Use should read: |
I've updated this in the telemetry PR |
Describe in detail the problem you had and how this PR fixes it
Update quick start guide and readme based on new flags introduced with #420
Adds a clause in bug report template about ide.coder.com issues
Is there an open issue you can link to?
n/a