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.

Sign up for GitHub

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

Jump to bottom

Transform docbook documentation into markdown #514

Closed
qsiebers opened this issue Jun 18, 2015 · 2 comments
Closed

Transform docbook documentation into markdown #514

qsiebers opened this issue Jun 18, 2015 · 2 comments
Labels
Component-Documentation Enhancement Newbie Release5.4.0 Issues resolved in release 5.4.0

Comments

@qsiebers
Copy link
Member

Pros:

  • Markdown has better support in GitHub
  • Markdown has better support in Maven
  • Strips away a lot of redundant markup code
  • Removal of buggy docbook plugin
  • Removal of ant code to fix distribution documentation

Cons:

  • Refactoring all documentation
  • No link checking (but already semi broken due to modularization)

Thoughts?
@qsiebers
Copy link
Member Author

We can upgrade the existing docbook pages to a newer docbook format, and then use a tool like Pandoc to transform them (semi)automatically to markdown

@qsiebers
Copy link
Member Author

Markdown based documentation is merged into master and will be included in next releases

@qsiebers qsiebers added the Release5.4.0 Issues resolved in release 5.4.0 label Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Component-Documentation Enhancement Newbie Release5.4.0 Issues resolved in release 5.4.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@qsiebers