Skip to content

Conversation

@lubska
Copy link
Contributor

@lubska lubska commented Jan 27, 2026

This PR fixes #1562

Implemented changes:

update dokumentation regarding environmental variables:
updates Variables table in Documentation
adds new variables to the table
adds link to an Interface that defines all the available variables

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

update Variables table
Add new variables to the table
Add link to an Interface that defines all the available variables
@CLAassistant
Copy link

CLAassistant commented Jan 27, 2026

CLA assistant check
All committers have signed the CLA.

@lubska lubska moved this from 🆕 New to 🏗 In progress in IDEasy board Jan 27, 2026
@coveralls
Copy link
Collaborator

coveralls commented Jan 27, 2026

Pull Request Test Coverage Report for Build 21512683408

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 70.456%

Totals Coverage Status
Change from base Build 21490876384: 0.0%
Covered Lines: 10483
Relevant Lines: 14293

💛 - Coveralls

@lubska lubska self-assigned this Jan 27, 2026
@lubska lubska added the documentation Improvements or additions to documentation label Jan 27, 2026
@lubska lubska requested review from SDallmann and hohwille January 27, 2026 12:59
Copy link
Contributor

@SDallmann SDallmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were the examples for «TOOL»_VERSION and «TOOL»_EDITION intentionally removed?
Other than that, everything looks good to me 👍

@lubska lubska moved this from 🏗 In progress to Team Review in IDEasy board Jan 29, 2026
@lubska
Copy link
Contributor Author

lubska commented Jan 29, 2026

Were the examples for «TOOL»_VERSION and «TOOL»_EDITION intentionally removed? Other than that, everything looks good to me 👍

Thanks for your review! Since these examples cannot contain exact values because they depend on the tool in question , it was decided to leave them empty

@hohwille hohwille added this to the release:2026.02.001 milestone Jan 29, 2026
Copy link
Member

@hohwille hohwille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lubska thanks for your PR. You went through all variables and added example values. 👍
Only after reviewing the documentation I remembered that we provide the default value here (if defined in IdeVariables) or otherwise given an reasonable example with an i.e. prefix.
I added some constructive review comments that you can apply (in diff you as a batch in one commit).
Then we can merge your PR.

@github-project-automation github-project-automation bot moved this from Team Review to 👀 In review in IDEasy board Jan 29, 2026
@hohwille hohwille changed the title Feature/#1562 update dokumentation regarding environmental variables #1562: update dokumentation regarding environmental variables Jan 30, 2026
Copy link
Member

@hohwille hohwille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lubska thanks for the update and conflict resolution. You did all correct 👍
Unfortunately I missed one little detail in my first review.
We can submit/apply that suggestion and then finally merge.

@hohwille hohwille merged commit 70a7fbf into devonfw:main Jan 30, 2026
4 checks passed
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in IDEasy board Jan 30, 2026
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: ✅ Done

Development

Successfully merging this pull request may close these issues.

Add more examples to Variables documentation

5 participants