Hello from New York City! Is there a process to contribute to KMyMoney documentation? Thank you.
Thanks for the offer. I am the primary maintainer of the documentation. The current main effort is to prepare the handbook for the eventual release of version 5.2, which will be made from what is currently master branch in git. To save the translators from dealing with the frequent changes, the edit to the handbook is being done in a separate branch Handbook-5.2. It is “mostly” done, but can always use an additional eyes to be sure it is accurate and complete. At some point in the next month of so, we well need to create a new set of screenshots, so if you are interested, you can read up on the process. (I would have to hunt for the link to the main KDE documentation on writing documentation, where they do have a section on screentshots.
Let us know if you have any specific questions as you start getting (or are you already) familiar with the docbook format and git.
1 Like
Happy Friday!
Thank you for reply.
Familiar with Git.
Familiar with EPUB, HTML, MarkDown, and Pandoc conversion process that can output to docbook format.
What are my next steps?
Thank you.
I’d start by cloning the git repo, checking out the Handbook-5.2 branch, and start perusing the files in the …/doc folder. The handbook is done diretly in docbook, so no need for any conversions. Creation of the html handbook as used by khelpcenter is taken care of as part of the normal build process, so you might want to try that also.
In actual working on the handbook, I don’t do a full build, but use checkXML5 to check for syntax errors, and then use meinproc5 to build an HTML file I can open with khelpcenter or even a regular browser.
This page is a good starting point for info on KDE documentation in general, I should probably review it myself.
In terms of actual tasks, in the root of the repo is a file README-CONTRIBUTORS where I’ve been keeping notes on issues I’ve noticed during my editing. I’ll also send you a PM with some other ideas.
The Handbook-5.2 branch repo has been downloaded.
Is the the correct github repo?
Please advise.
Thank you.
I’m not sure what you are using to look at it, but it is seems correct. I have NOT yet created a PR, so if you are looking at the Handbook-5.2 branch in your clone of the main repository, it always seems to talk in terms of any difference from main being a PR. Since I am pretty much the only person who edits the handbook, I have generally pushed changes directly, and only use a PR (either from the main branch of my clone or a temporary branch in the main repository) when I explicitly want someone to review it. I made a separate branch for this because I wanted to get the whole handbook done (or at least mostly to almost) before the translators started working on it.
Not really, because Github only hosts a read-only copy of the KDE repos where you cannot drop PRs. You’re better off to look at the source of truth on our (i.e. KDE’s) Gitlab repo at Office / KMyMoney · GitLab. Not sure if we can process PRs from Github in Gitlab.
1 Like
New question: Is there anything specific about the docs you are interested in addressing? Hopefully I’ve hit all the major deficiencies with the version in the Handbook5.2 branch, but there is clearly still more to be done. If you don’t have anything specific in mind to start, you can look through the file README-CONTRIBUTORS in the root folder, which has my notes of open issues.