Good first issues in the docs repo #4262
-
Hi, we would like to help the community to have better documentation and looking for good first issues on the docs repo. The current one are all looking very old and difficult. Can someone suggest some easy changes what we could address as a start? |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 2 replies
-
I would say the docs are almost bug free and they are really good. The list of issues is almost empty. @infotexture and others do a perfect job. Not sure if a big reworking is needed (this has happened already). Probably the challenge is to keep the docs as good as they are and I am sure that the biggest effort is to write the release notes. |
Beta Was this translation helpful? Give feedback.
-
@CsatariGergely 🙏 Thanks for your interest in the DITA-OT docs. We haven’t maintained a While some projects mark certain issues as “beginner friendly”, “easy bug fix”, or “low-hanging-fruit” and leave them open to encourage contributions, we generally prefer to fix things as soon as possible to ensure that the next version of the software ships with any suggestions we receive. That said, there are always suggestions that don’t get implemented, as the original reporter may not have had the time to propose changes, and others may not have known how. To keep our backlog manageable, issues that aren’t updated get marked as Apart from that, we have a few tips in the Documentation section under Contributing to DITA Open Toolkit on the project website. We’re open to suggestions, so if there’s anything your team has struggled with, file a docs issue (or send a pull request) and we’ll be happy to discuss how to make things easier to understand. |
Beta Was this translation helpful? Give feedback.
@CsatariGergely 🙏 Thanks for your interest in the DITA-OT docs.
We haven’t maintained a
good first issue
orhelp wanted
label in the docs backlog lately, as the nature of a tool like DITA-OT means there’s a certain learning curve for the documentation process.While some projects mark certain issues as “beginner friendly”, “easy bug fix”, or “low-hanging-fruit” and leave them open to encourage contributions, we generally prefer to fix things as soon as possible to ensure that the next version of the software ships with any suggestions we receive.
That said, there are always suggestions that don’t get implemented, as the original reporter may not have had the time to propose changes, and o…