Skip to content

#1063: improved missleading documentation (for user specific workspace configuration)#2041

Open
JoelAdbu wants to merge 6 commits into
devonfw:mainfrom
JoelAdbu:feature/1063-adjust-doc-user-specific-configuration
Open

#1063: improved missleading documentation (for user specific workspace configuration)#2041
JoelAdbu wants to merge 6 commits into
devonfw:mainfrom
JoelAdbu:feature/1063-adjust-doc-user-specific-configuration

Conversation

@JoelAdbu

@JoelAdbu JoelAdbu commented Jun 17, 2026

Copy link
Copy Markdown

This PR fixes #1063

Implemented changes:

  • clarified documentation regarding user-specific IDE workspace configuration
  • documented that workspace templates can also be defined in ~/.ide/«ide»/workspace/
  • added note about required directory structure (settings subfolder)

Testing instructions

Please add conscise, understandable instructions on how a reviewer can test/verify the functionality of your contribution here:

  1. Add custom workspace configuration files to ~/.ide/intellij/workspace/update/.intellij/config/options/.
  2. Create an advancedSettings.xml file with the following content:
<application xmlns:merge="https://github.com/devonfw/IDEasy/merge">
  <component name="AdvancedSettings">
    <option name="settings">
      <map>
        <entry merge:id="@key"
               key="bigger.font.in.project.view"
               value="true" />
        <entry key="documentation.components.enable.highlighting.of.links"
               value="true" />
        <entry key="ide.ui.non.modal.settings.window"
               value="true" />
      </map>
    </option>
  </component>
</application>
  1. Run ide update
  2. Open Intellij in a workspace
  3. Verify that the Settings dialog opens as a tab in the editor instead of a modal window.
  4. Open IntelliJ in another workspace/project and verify that the same setting is applied there as well.
  5. Remove the following line from advancedSettings.xml:
 <entry key="ide.ui.non.modal.settings.window" value="true" />
  1. ide update
  2. check again for both workspaces and verify that the Settings dialog no longer opens as a tab in the editor, but as a modal dialog.

Checklist for this PR

Make sure everything is checked before merging this PR. For further info please also see
our DoD.

  • When running mvn clean test locally all tests pass and build is successful
  • PR title is of the form #«issue-id»: «brief summary» (e.g. #921: fixed setup.bat). If no issue ID exists, title only.
  • PR top-level comment summarizes what has been done and contains link to addressed issue(s)
  • PR and issue(s) have suitable labels
  • Issue is set to In Progress and assigned to you or there is no issue (might happen for very small PRs)
  • You followed all coding conventions
  • You have added the issue implemented by your PR in CHANGELOG.adoc unless issue is labeled
    with internal
  • You have formulated clear instructions on how to test your contribution under "Testing instructions"

@CLAassistant

CLAassistant commented Jun 17, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coveralls

coveralls commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 28702536973

Coverage decreased (-0.04%) to 71.789%

Details

  • Coverage decreased (-0.04%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 3 coverage regressions across 2 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

3 previously-covered lines in 2 files lost coverage.

File Lines Losing Coverage Coverage
com/devonfw/tools/ide/version/VersionSegment.java 2 89.5%
com/devonfw/tools/ide/tool/ide/IdeToolCommandlet.java 1 78.33%

Coverage Stats

Coverage Status
Relevant Lines: 16300
Covered Lines: 12197
Line Coverage: 74.83%
Relevant Branches: 7308
Covered Branches: 4751
Branch Coverage: 65.01%
Branches in Coverage %: Yes
Coverage Strength: 3.17 hits per line

💛 - Coveralls

@JoelAdbu JoelAdbu added the documentation Improvements or additions to documentation label Jun 17, 2026
@JoelAdbu JoelAdbu self-assigned this Jun 17, 2026
@JoelAdbu JoelAdbu changed the title #1063: improved missleading documentation #1063: improved missleading documentation (for user specific workspace configuration) Jun 17, 2026
@JoelAdbu JoelAdbu moved this from 🆕 New to 🏗 In progress in IDEasy board Jun 17, 2026
@JoelAdbu JoelAdbu marked this pull request as ready for review June 17, 2026 14:31
@JoelAdbu JoelAdbu requested a review from laert-ll June 17, 2026 14:32
@hohwille hohwille moved this from 🏗 In progress to Team Review in IDEasy board Jun 18, 2026
@JoelAdbu JoelAdbu force-pushed the feature/1063-adjust-doc-user-specific-configuration branch from 09f4039 to d2b045c Compare June 24, 2026 13:09
@laert-ll

Copy link
Copy Markdown
Contributor

Apologies for the PR review delay, there was quite a bit of confusion from my side about this issue.

The original bug report stated that the settings stored in ~/.ide/intellij\workspace\update\.intellij\config\options\advancedSettings.xml were not being used by the ide globally (e.g. independently by other instances of the ide in other projects). However, when testing it locally, this was exactly the path which worked:

Intellij default font size:
image

Then I copied the editor-font.xml setting file from ~/projects/IDEasy/workspaces/main/.intellij/config/options/ to ~/.ide/intellij/workspace/update/.intellij/config/options/ and edited it manually to another value (14).

Then, I opened intellij from another project folder and checked that the manually changed font settings were applied:
image

After digging a bit more, it seemed like the #1063 bug report was probably due to an IDE version being tested which was not up to date. This was reported under IDEasy: 2025.01.001-beta-01_21_02-SNAPSHOT (21/01/2025), which predates #1010 (07/02/2025) where this functionality was implemented.

So ~/.ide/settings/«ide»/workspace/ is not the correct path to place global ide settings, the settings subfolder applies to plugins (~/.ide/settings/<ide>/plugins/), not to workspace configuration. However it would still be nice to have some more elaborate clarification in the documentation on where the file settings should be placed instead (~/.ide/<ide>/workspace/).

JoelAdbu and others added 3 commits July 1, 2026 11:23
- fixed false documentation about IDE specific configurations in configuration.adoc
…oc-user-specific-configuration

# Conflicts:
#	CHANGELOG.adoc
…-doc-user-specific-configuration

# Conflicts:
#	CHANGELOG.adoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Team Review

Development

Successfully merging this pull request may close these issues.

User specific configurations are not working as described

6 participants