Skip to content

#1748: improve IDEasy status documentation#1897

Open
MarvMa wants to merge 15 commits into
devonfw:mainfrom
MarvMa:feature/#1748-improve-status-doc
Open

#1748: improve IDEasy status documentation#1897
MarvMa wants to merge 15 commits into
devonfw:mainfrom
MarvMa:feature/#1748-improve-status-doc

Conversation

@MarvMa
Copy link
Copy Markdown
Contributor

@MarvMa MarvMa commented May 6, 2026

This PR fixes #1748

Implemented changes:

  • created a python script to generate a quality-status.adoc file
  • the generated quality-status.adoc is beeing referenced in the readme.md and contains an overview with all the open issues for each os with a classification for blocker, bugs or features.

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

@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented May 6, 2026

Coverage Report for CI Build 25716448412

Coverage increased (+0.05%) to 70.673%

Details

  • Coverage increased (+0.05%) 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: 15471
Covered Lines: 11393
Line Coverage: 73.64%
Relevant Branches: 6918
Covered Branches: 4430
Branch Coverage: 64.04%
Branches in Coverage %: Yes
Coverage Strength: 3.11 hits per line

💛 - Coveralls

@MarvMa MarvMa self-assigned this May 7, 2026
@MarvMa MarvMa moved this from 🆕 New to Team Review in IDEasy board May 7, 2026
@MarvMa MarvMa changed the title Feature/#1748 improve status doc #1748: improve status doc May 7, 2026
@MarvMa MarvMa changed the title #1748: improve status doc #1748: improve IDEasy status documentation May 7, 2026
@hohwille hohwille added documentation Improvements or additions to documentation enhancement New feature or request labels May 7, 2026
@MarvMa MarvMa marked this pull request as ready for review May 8, 2026 06:42
Copy link
Copy Markdown
Contributor

@jakozian jakozian left a comment

Choose a reason for hiding this comment

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

Very nice looking quality-status documentation!

@laim2003 laim2003 self-requested a review May 8, 2026 08:26
Copy link
Copy Markdown
Contributor

@laim2003 laim2003 left a comment

Choose a reason for hiding this comment

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

Looks very good! I’ve taken a look at it now and everything looked great.
Are there already ideas on when this should be executed?
I’m thinking of an action that runs either as part of the nightly build or on every PR build, so that the file is always up to date.

@jakozian jakozian removed their assignment May 8, 2026
@MarvMa
Copy link
Copy Markdown
Contributor Author

MarvMa commented May 8, 2026

Looks very good! I’ve taken a look at it now and everything looked great. Are there already ideas on when this should be executed? I’m thinking of an action that runs either as part of the nightly build or on every PR build, so that the file is always up to date.

I suppose it makes sense to run this every release to balance resource overhead and actuality

@MarvMa MarvMa moved this from Team Review to 👀 In review in IDEasy board May 12, 2026
@MarvMa MarvMa requested a review from hohwille May 12, 2026 05:59
@hohwille hohwille added this to the release:2026.05.001 milestone May 17, 2026
Removed outdated information about OS support and developer team recommendations.
Copy link
Copy Markdown
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.

@MarvMa thanks for your PR. Great job to generate this with some python magic... 👍
When we update the report, this can be merged.
I would however, prefer to have also a workflow to regenerate with a click (and at least once per month or week automatically).

@@ -0,0 +1,1468 @@
= IDEasy Quality Status
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.

very nice. I especially like the emoji/Unicode-icons and the overview.
Maybe should generate separate docs per OS and link them from the Readme per OS with according OS icon/emoji? I fear that 99% of the users never make it below the initial table that lists the overall issues that is currently quite long...

I found lots of issues in this list that have been fixed already but were never closed.
I updated and closed them on GitHub so we should rerun your tool to get a fresh list.

I like this idea very much but I will not be able to rerun the status script frequently and therefore have doubts that anybody else will ever do.
If we want to go for this approach we have to integrate it as a GHA workflow.

In the end we could do the same thing with GitHub issue queries.
Currently this report also mixes severe bugs (tool xyz cannot even be installed on Mac) with totally irrelevant edge-case issues (e.g. auto-completion is not perfect).
Therefore I cannot easily see if I really have big problems on my OS.
I could also go to the issue tracker and filter by the desired OS label to get the same list of many issues listed but would need to go through all of them to get a real impression if IDEasy works fine or catastrophic on that OS.
Could we do the same somehow with something like iframes in adoc or md file?
Is it also possible to get additional metadata from the issues like priority? This could really make a difference if we distinguish by that and maybe even ignore Low prio issues and rank Urgent issues accordingly...
Great that you already make use of the Blocker issue.

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 enhancement New feature or request

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

Improve IDEasy status documentation

6 participants