-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Apply editor configurations from a ConfigMap (#2841)
* docs: Apply editor configurations from a ConfigMap Signed-off-by: RomanNikitenko <[email protected]> * Update modules/administration-guide/pages/editor-configurations-for-microsoft-visual-studio-code.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Update modules/administration-guide/pages/editor-configurations-for-microsoft-visual-studio-code.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Update modules/administration-guide/pages/editor-configurations-for-microsoft-visual-studio-code.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Update modules/administration-guide/pages/editor-configurations-for-microsoft-visual-studio-code.adoc Co-authored-by: Jana Vrbkova <[email protected]> * Update formatting for ConfigMap sections Signed-off-by: RomanNikitenko <[email protected]> --------- Signed-off-by: RomanNikitenko <[email protected]> Co-authored-by: Jana Vrbkova <[email protected]>
- Loading branch information
1 parent
1f8e947
commit a2fe463
Showing
3 changed files
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
...tration-guide/pages/editor-configurations-for-microsoft-visual-studio-code.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
:_content-type: PROCEDURE | ||
:description: Applying editor configurations | ||
:keywords: settings, extensions, configurations | ||
:navtitle: Applying editor configurations | ||
// :page-aliases: | ||
|
||
[id="visual-studio-code-editor-configs"] | ||
= Applying editor configurations | ||
|
||
You can configure Visual Studio Code - Open Source editor by adding configurations to a ConfigMap. | ||
These configurations are applied to any workspace you open. | ||
Once a workspace is started, the editor checks for this ConfigMap and stores configurations to the corresponding config files. | ||
|
||
The following sections are currently supported: | ||
|
||
* settings.json | ||
* extensions.json | ||
|
||
The `settings.json` section contains various settings that allow to customize different parts of the Code - OSS editor. + | ||
The `extensions.json` section contains recommented extensions are installed when a workspace is started. | ||
|
||
.Procedure | ||
|
||
* Add a new ConfigMap to the user's {orch-namespace}, define the `settings.json` and `extensions.json` sections, specify the settings you want to add, and the IDs of the extensions you want to install. | ||
+ | ||
==== | ||
[source,yaml] | ||
---- | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: vscode-editor-configurations | ||
data: | ||
extensions.json: | | ||
{ | ||
"recommendations": [ | ||
"dbaeumer.vscode-eslint", | ||
"github.vscode-pull-request-github" | ||
] | ||
} | ||
settings.json: | | ||
{ | ||
"window.header": "A HEADER MESSAGE", | ||
"window.commandCenter": false, | ||
"workbench.colorCustomizations": { | ||
"titleBar.activeBackground": "#CCA700", | ||
"titleBar.activeForeground": "#ffffff" | ||
} | ||
} | ||
immutable: false | ||
---- | ||
==== | ||
|
||
* Start or restart your workspace | ||
|
||
[NOTE] | ||
==== | ||
Make sure that the Configmap contains data in a valid JSON format. | ||
==== | ||
|
||
.Verification | ||
. Verify that settings defined in the ConfigMap are applied using one of the following methods: | ||
* Use `F1 → Preferences: Open Remote Settings` to check if the defined settings are applied. | ||
* Ensure that the settings from the ConfigMap are present in the `/checode/remote/data/Machine/settings.json` file by using the `F1 → File: Open File...` command to inspect the file's content. | ||
|
||
. Verify that extensions defined in the ConfigMap are applied: | ||
* Go to the `Extensions` view (`F1 → View: Show Extensions`) and check that the extensions are installed | ||
* Ensure that the extensions from the ConfigMap are present in the `.code-workspace` file by using the `F1 → File: Open File...` command. By default, the workspace file is placed at `/projects/.code-workspace`. | ||
|
||
|