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

Transform docbook documentation into markdown #514

Open
qsiebers opened this Issue Jun 18, 2015 · 1 comment

Comments

Projects
None yet
1 participant
@qsiebers
Member

qsiebers commented Jun 18, 2015

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

This comment has been minimized.

Member

qsiebers commented Jun 19, 2015

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 qsiebers added Enhancement and removed enhancement labels Apr 11, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment