Der Pepe (Hubzilla) ⁂ ⚝

Hubzilla-Hilfe / Hubzilla-Help

2025-05-26 12:55:01

pepecyb@hub.hubzilla.hu

So, mal als "Wasserstandsmeldung": Derzeit arbeite ich aktiv daran, die komplett überarbeitete Hubzilla-Hilfe, die zur Ansicht unter

https://help.hubzilla.hu/ (de) und

https://help.hubzilla.hu/en (en) zur Verfügung steht, für die Einbindung in Hubzilla selbst anzupassen. Ist lediglich Fleißarbeit, die aber auch volle Konzentration erfordert.

Dank @Harald Eilertsen habe ich jetzt auch endlich durchblicken können, wie das Hilfe-System unter Hubzilla hinter den Kulissen funktioniert. Das System nimmt einem etliches an Arbeit ab und es kommt letztlich überwigend auf die Ordner- und Dateistruktur an. Eine Überraschung war für mich, dass der Markdown-Parser des Hilfesystems ein "#include-Anweisung" kennt, mit welcher der Titel von eingebundenen Markdown-Dateien in Form eines TOC als anklickbare Links eingebunden werden.

Harald hat meine englischsprachige Hilfe bereits in den Entwicklungszweig eingepflegt. Ich erledige das nun für die deutschsprachige Hilfe. Dabei sind mir ein paar Fehler aufgefallen, die ich Harald auch noch mittilen werde, weil sie natürlich auch in der englischen Version vorhanden sind (hab die deutsche Version ja praktisch überwiegend nur übersetzt und dabei "elegant" ein paar "Korken" mit übernommen).

Ich freue mich drauf, wenn die Hilfe in Hubzilla endlich wiedernutzbar und nützlich sein wird...

---

So, just to give you an update: I am currently working hard on integrating the completely revised Hubzilla help section, which is available at

https://help.hubzilla.hu/ (de) and

https://help.hubzilla.hu/en (en), into Hubzilla itself. It's just tedious work, but it requires my full attention.

Thanks to @Harald Eilertsen , I have finally been able to figure out how the help system works behind the scenes in Hubzilla. The system takes a lot of work off your hands and ultimately it all comes down to the folder and file structure. I was surprised to find that the help system's Markdown parser recognises a ‘#include statement’, which allows the titles of included Markdown files to be integrated as clickable links in the form of a table of contents.

Harald has already added my English help to the development branch. I'm now doing the same for the German help. I noticed a few errors, which I will also report to Harald, because they are of course also present in the English version (I basically just translated the German version and “elegantly” copied a few blunders)

I'm looking forward to the help in Hubzilla finally being usable and useful again...

#hubzilla #hilfe #help #manual

show all 5 comments

2025-05-29 09:55:22

Peter Olsen

petero@klacker.org

It is a great improvement! Nevertheless, as a beginner I have the ability to see a lot of beginner's questions which are difficult to find answers to in the (new or old) help system. Occasionally I also discover minor errors in the new help which could easily be corrected. Those thoughts led me to start to read in some of the "developer" and "contribution" sections. I am a retired software engineer, so I know the basics of using git and issue management. But where is the "issue management", both for Hubzilla core itself and the help documentation? I have spent about 30 minutes searching, and finally I found two places of interest: In the new help in section "To-be-organised information" (5.23) there is a link to "Channel one" (

https://zothub.com/channel/one). However, the link is broken (for me, at least). I also found "issue management" on the git-site "https://framagit.org/hubzilla/core/-/issues". However, that seems to have a rather flat structure. But is the "issue management" the way to go? Should I join the community and create an account there in order to proceed with some sort of "documentation improvement proposals" or "Bugs" directed at the documentation, in the case of obvious errors?

2025-05-29 10:39:21

Harald Eilertsen

harald@hub.volse.no

@Peter Olsen Awesome that you want to help!

Yes the issue tracker is at

https://framagit.org/hubzilla/core/-/issues. (For the core project, including the documentation. There's separate issue trackers for the addon, themes and widget repos) There's a documentation label you can add for documentation related issues.

If you don't want to register an account at Framagit, we can also accept documentation related patches or suggestions in the @Hubzilla Documentation Team forum.

I can also relate to your situation. While I've been using Hubzilla for years myself, I'm just now onboarding a few new user to my hub, and while I would like to direct them to the new docs, sometimes I have to explain things myself in a way that's more approachable to people with no knowledge of Hubzilla at all.

But I think that with the huge job that @Der Pepe (Hubzilla) ⁂ ⚝ has done, these are incremental changes that are a lot easier to get done now.

2025-05-29 10:45:42

Tags