Skip to content

#2253: Fix structure and log documentation - #2272

Merged
hohwille merged 15 commits into
devonfw:mainfrom
krystynaShatkovska:issue-2253-doc-structure-logs
Aug 18, 2026
Merged

#2253: Fix structure and log documentation #2272
hohwille merged 15 commits into
devonfw:mainfrom
krystynaShatkovska:issue-2253-doc-structure-logs

Conversation

@krystynaShatkovska

@krystynaShatkovska krystynaShatkovska commented Aug 6, 2026 •
edited by hohwille
Loading

Copy link
Copy Markdown
Contributor

This PR fixes #2253

Implemented changes:

  • Updated structure.adoc to reflect the current IDEasy directory structure.
  • Moved log documentation to $IDE_ROOT/_ide/logs.
  • Added documentation for tmp.
  • Added documentation for urls.
  • Extended log.adoc with:
    • log location
    • log directory structure
    • installation and uninstallation logs
    • log-level behavior
    • trace logging behavior
    • cleanup information

Testing instructions

  1. Checkout branch issue-2253-doc-structure-logs
  2. Run:
ide mvn clean install

Checklist for this PR

  • When running mvn clean test locally all tests pass and build is successful
  • PR title is of the form #«issue-id»: «brief summary»
  • 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"

@github-project-automation github-project-automation Bot moved this to 🆕 New in IDEasy board Aug 6, 2026
@CLAassistant

CLAassistant commented Aug 6, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@vivu001 vivu001 moved this from 🆕 New to 🏗 In progress in IDEasy board Aug 7, 2026
@krystynaShatkovska krystynaShatkovska changed the title Fix structure and log documentation (#2253) #2253 Fix structure and log documentation Aug 7, 2026
@krystynaShatkovska krystynaShatkovska self-assigned this Aug 7, 2026
@krystynaShatkovska krystynaShatkovska moved this from 🏗 In progress to Team Review in IDEasy board Aug 7, 2026
@krystynaShatkovska krystynaShatkovska added the documentation Improvements or additions to documentation label Aug 7, 2026
@krystynaShatkovska
krystynaShatkovska force-pushed the issue-2253-doc-structure-logs branch from 1787cce to 9768f81 Compare August 7, 2026 07:53
@coveralls

coveralls commented Aug 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 32145967611

Coverage increased (+0.02%) to 72.945%

Details

  • Coverage increased (+0.02%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.

Coverage Stats

Coverage Status
Relevant Lines: 17556
Covered Lines: 13354
Line Coverage: 76.07%
Relevant Branches: 7759
Covered Branches: 5112
Branch Coverage: 65.88%
Branches in Coverage %: Yes
Coverage Strength: 3.23 hits per line
💛 - Coveralls

@krystynaShatkovska krystynaShatkovska added the enhancement New feature or request label Aug 7, 2026
samuelkos17
samuelkos17 reviewed Aug 7, 2026
View reviewed changes

@samuelkos17 samuelkos17 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great Work! Thanks a lot for updating the documentation, i see no problem with your changes so I'll move this to In Review 😄

@samuelkos17 samuelkos17 moved this from Team Review to 👀 In review in IDEasy board Aug 7, 2026
@krystynaShatkovska krystynaShatkovska added the QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented. label Aug 10, 2026
hohwille
hohwille approved these changes Aug 10, 2026
View reviewed changes

@hohwille hohwille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@krystynaShatkovska thank you for your PR. Nice that you created and improved this documentation and figured out the details to describe this properly. 👍
I added some insights and suggest to omit the cleanup status - your hints are correct but then we very soon need another PR removing that and we even might forget about it.
Most likely cleanup will be improved accordingly before many users have found and read the new documentation. 😄

Comment thread documentation/tmp.adoc Outdated
Comment thread documentation/log.adoc Outdated
Comment thread documentation/log.adoc Outdated
Comment thread documentation/log.adoc Outdated
Comment thread documentation/log.adoc Outdated
Comment thread documentation/urls.adoc Outdated
@hohwille hohwille changed the title #2253 Fix structure and log documentation #2253: Fix structure and log documentation Aug 10, 2026
krystynaShatkovska and others added 7 commits August 12, 2026 11:03
@krystynaShatkovska @hohwille
Update documentation/tmp.adoc
a377057 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska @hohwille
Update documentation/log.adoc
38150d6 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska @hohwille
Update documentation/log.adoc
0c59639 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska @hohwille
Update documentation/urls.adoc
e3559bf 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska @hohwille
Update documentation/log.adoc
5d185ec 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska @hohwille
Update documentation/log.adoc
c421460 
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
@krystynaShatkovska
Merge branch 'main' into issue-2253-doc-structure-logs
56b7ec6
@krystynaShatkovska

krystynaShatkovska commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

@hohwille thank you for recommendations!

krystynaShatkovska and others added 2 commits August 13, 2026 10:41
@krystynaShatkovska
Merge branch 'main' into issue-2253-doc-structure-logs
5306b57
@hohwille
constructive review fix
28949f9 
since a suggestions was applied where GItHub got confused about the markup and detected the start of a code block as the end of the suggestion.
hohwille
hohwille approved these changes Aug 13, 2026
View reviewed changes

@hohwille hohwille left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@krystynaShatkovska thanks for the review rework. Can you please check the CHANGELOG so I can finally merge? Thanks in advance.

Comment thread CHANGELOG.adoc
Comment thread documentation/log.adoc Outdated
@hohwille hohwille added this to the release:2026.08.002 milestone Aug 18, 2026
@hohwille
hohwille merged commit ee10330 into devonfw:main Aug 18, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in IDEasy board Aug 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hohwille hohwille hohwille approved these changes
+1 more reviewer
@samuelkos17 samuelkos17 samuelkos17 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@samuelkos17 samuelkos17

@krystynaShatkovska krystynaShatkovska

Labels

documentation Improvements or additions to documentation enhancement New feature or request QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented.

Projects

IDEasy board
Status: ✅ Done

Milestone

release:2026.08.002

Development

Successfully merging this pull request may close these issues.

Improve/fix documentation of structure and logs

7 participants

@krystynaShatkovska @CLAassistant @coveralls @hohwille @samuelkos17 @vivu001 @maybeec