Updated MR for new docs -

System Apps

Directory Help Language

Like Us Public Stream QRator Random Channel Report Bug Search

Support Hubzilla

Updated MR for new docs

2025-05-15 23:28:21

Hubzilla Documentation Team

documentation@hubzilla.org

Harald Eilertsen wrote the following post Thu, 15 May 2025 23:27:59 +0200

Updated MR for new docs

I've updated the merge request for the new docs and marked it as ready for merging. Please have a look and file any objections or suggestions in the MR here:

https://framagit.org/hubzilla/core/-/merge_requests/2189

This does not include the German docs, that needs to be done by someone more capable in German than me. But it should be relatively trivial (but a bit of work) once this MR passes review. Any other languages will have to be translated again as well.

Sorry this has taken so long time! I've not had much time to work on Hubzilla stuff for the past six months.

show all 8 comments

2025-05-16 00:02:59

Der Pepe (Hubzilla) ⁂ ⚝

pepecyb@hub.hubzilla.hu

@Harald Eilertsen

This does not include the German docs, that needs to be done by someone more capable in German than me.

What needs to be done with the German documentation? How can I help?

Ultimately, the documents/files must be handled in exactly the same way as the English documentation. You don't need to understand German to do this. The files and file names, as well as the scope of the files, must correspond 1:1 to the English files. It is a 100% copy of the English structure, but the content (of the documents) is in German.

2025-05-16 08:49:39

Harald Eilertsen

harald@hub.volse.no

@Der Pepe (Hubzilla) ⁂ ⚝ Essentially it's just good to know the language when moving it around. There's some light editing of the files required, not much, but it's good to be able to verify that things end up where they should, and that the text makes sense afterwards.

I probably could do it, but it would take me longer than with the English version. It would be great if you or someone with better German skills than me could help.

What needs to be done:

Delete the old docs
Move the files from the doc repo to the doc/de directory in the core repo
Rename doc/de/usermanual to doc/de/member
Rename doc/de/develmanual to doc/de/developer
Add/translate the doc/de/toc.html file (use doc/en/toc.html as template)
Add the relevant #include statements to the markdown files (see the english files for reference)
Fix the image and link URL's in the markdown files
Possibly adjust the heading levels so that it all makes sense

Edit: And of course I'm available, and happy to help!

2025-05-16 11:46:03

Scott M. Stolz

scott@loves.tech

@Harald Eilertsen Should the English documents be merged before submitting a German language merge request, to avoid conflicts?

2025-05-16 11:49:24

Harald Eilertsen

harald@hub.volse.no

@Scott M. Stolz That's probably the easiest, but as long as it builds on top of the branch of the MR it should be fine.

2025-05-16 11:56:26

Der Pepe (Hubzilla) ⁂ ⚝

pepecyb@hub.hubzilla.hu

@Scott M. Stolz @Harald Eilertsen

No need to "panic". I will take my time with the adjustments, and it will certainly take some time (and I am sure I will have questions along the way). Before I'll submit it, I'll post here anyway so that someone else who is familiar with Hubzilla's documentation structure can take a critical look at it. I'll leave it up to Harald to decide when it will be added. ;-)

2025-05-16 16:11:27

Der Pepe (Hubzilla) ⁂ ⚝

pepecyb@hub.hubzilla.hu

@Harald Eilertsen

And of course I'm available, and happy to help!

Here is the first question regarding adjustments to links in the Markdown files:

Do they have to be fully referenced URLs (e.g. "/doc/de/member/document.md"), or do relative links (e.g. "./document.md") also work?

I assume fully referenced links, as seems to be the case with the images...

2025-05-16 17:10:59

Der Pepe (Hubzilla) ⁂ ⚝

pepecyb@hub.hubzilla.hu

Ah, now I see what you have done. For documents in the same directory, no path is required. For cross-directory links, I will reference them completely to be on the safe side. The same applies to images.

2025-05-16 17:42:20

Harald Eilertsen

harald@hub.volse.no

@Der Pepe (Hubzilla) ⁂ ⚝ The URLs must work in the browser, so you want /help/member/my_topic. Leave out the language and the extension.