docs: document OPEN_PROJECTS_ROOT_ON_EMPTY env var #3195
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -89,3 +89,23 @@ If the workspace file does not exist in the first project, a new one will be cre | |
| - name: VSCODE_DEFAULT_WORKSPACE | ||
| value: "/" | ||
| ---- | ||
|
|
||
| * Open the projects root folder in empty workspaces. | ||
|
|
||
| ** By default, when a workspace has no projects defined in its devfile (for example, the dashboard's built-in "Empty Workspace"), the editor opens with an empty Explorer. To automatically open the `/projects` folder instead, define the __OPEN_PROJECTS_ROOT_ON_EMPTY__ environment variable in your devfile. | ||
| + | ||
| pass:[<!-- vale RedHat.TermsErrors = NO -->] | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| env: | ||
|
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: git diff 6f086cda598e8cfadce8206a4c770f8b3d47a551 41d6527184f2ee9b66a9d416a492417614332fb6 -- modules/administration-guide/pages/configuring-single-and-multiroot-workspaces.adoc
rg -n 'vale|TermsErrors|reviewdog|filter-mode' .github .vale.ini .vale* 2>/dev/nullRepository: eclipse-che/che-docs Length of output: 3062 🏁 Script executed: set -e
printf '%s\n' '--- .vale.ini ---'
cat -n .vale.ini
printf '%s\n' '--- Vale workflow ---'
cat -n .github/workflows/vale.yml
printf '%s\n' '--- relevant style files ---'
git ls-files '.vale/styles' | sort
rg -n -i 'TermsErrors|environment|env|code|block|markup' .vale/styles .vale.ini 2>/dev/null | head -200
printf '%s\n' '--- reviewed head lines 70-108 ---'
git show 41d6527184f2ee9b66a9d416a492417614332fb6:modules/administration-guide/pages/configuring-single-and-multiroot-workspaces.adoc | nl -ba | sed -n '70,108p'
printf '%s\n' '--- base lines 70-100 ---'
git show 6f086cda598e8cfadce8206a4c770f8b3d47a551:modules/administration-guide/pages/configuring-single-and-multiroot-workspaces.adoc | nl -ba | sed -n '70,100p'Repository: eclipse-che/che-docs Length of output: 6897 🏁 Script executed: rg -n -i 'vale[[:space:]]+(off|on|ignore)|vale-ignore|TermsErrors[[:space:]]*=' --glob '*.adoc' --glob '*.md' --glob '*.ini' --glob '*.yaml' --glob '*.yml' .Repository: eclipse-che/che-docs Length of output: 380 🌐 Web query:
💡 Result: Keep the YAML key and add a scoped Vale exception. The existing global configuration already skips code blocks. CI still reports the added Suggested fix+pass:[<!-- vale RedHat.TermsErrors["env"] = NO -->]
[source,yaml]
----
env:
- name: OPEN_PROJECTS_ROOT_ON_EMPTY
value: "true"
----
+pass:[<!-- vale RedHat.TermsErrors["env"] = YES -->]🧰 Tools🪛 GitHub Actions: Linting with Vale / 0_Linting with Vale.txt[error] 77-99: Vale RedHat.TermsErrors: Use 'environment' rather than 'env' at lines 77, 88, and 99. 🪛 GitHub Actions: Linting with Vale / Linting with Vale[error] 77-99: Vale (RedHat.TermsErrors) reported 'env' should be replaced with 'environment' at lines 77, 88, and 99. 🪛 GitHub Check: Linting with Vale[failure] 99-99: Raw Output: 🤖 Prompt for AI Agents |
||
| - name: OPEN_PROJECTS_ROOT_ON_EMPTY | ||
| value: "true" | ||
| ---- | ||
| + | ||
| pass:[<!-- vale RedHat.TermsErrors = YES -->] | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| This setting only applies when the workspace has no projects, dependent projects, or starter projects defined. Workspaces that already have folders configured are not affected. | ||
| ==== | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: eclipse-che/che-docs
Length of output: 1406
🌐 Web query:
che-code pr-798 OPEN_PROJECTS_ROOT_ON_EMPTY code-workspace.ts project synchronization missing directories💡 Result:
🏁 Script executed:
Repository: eclipse-che/che-docs
Length of output: 7260
Document the launcher’s folder-based condition.
The launcher checks
workspace.foldersafter synchronizing projects, dependent projects, and starter projects. It skips projects whose directories do not exist. Therefore, a devfile can define projects and still triggerOPEN_PROJECTS_ROOT_ON_EMPTYwhen synchronization leaves no folders.Update the description and note:
Suggested documentation fix
📝 Committable suggestion
🧰 Tools
🪛 GitHub Actions: Linting with Vale / 0_Linting with Vale.txt
[error] 77-99: Vale RedHat.TermsErrors: Use 'environment' rather than 'env' at lines 77, 88, and 99.
🪛 GitHub Actions: Linting with Vale / Linting with Vale
[error] 77-99: Vale (RedHat.TermsErrors) reported 'env' should be replaced with 'environment' at lines 77, 88, and 99.
🤖 Prompt for AI Agents