Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move away from DocBook for documentation #1588

Open
rdmark opened this issue Oct 3, 2024 · 0 comments
Open

Move away from DocBook for documentation #1588

rdmark opened this issue Oct 3, 2024 · 0 comments

Comments

@rdmark
Copy link
Member

rdmark commented Oct 3, 2024

The DocBook toolchain relies on XML parsing and XSL stylesheets that is heavy, complex, and partially on the verge of obsolescence.

For one, we use traditional non-namespaced DocBook XSL style sheets which are two generations behind where DocBook is today. The docbook-xsl package is orphaned in Debian, for instance.

Another concrete drawback is that Debian tries to proactively strip XML related dependencies from architecture dependent builds, to save on computing resources and speed up builds. But this can’t be done for netatalk because of how we generate the troff man pages from XML.

This is to look into converting the documentation sources to a markup format that is parseable by pandoc, such as Commonmark. This would allow us to transcode to human readable formats with the light-weight cmark.

@rdmark rdmark added this to the release-4.1 milestone Oct 12, 2024
@rdmark rdmark removed this from the release-4.1 milestone Jan 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant