[
https://issues.apache.org/jira/browse/GUACAMOLE-1347?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17349602#comment-17349602
]
Mike Jumper commented on GUACAMOLE-1347:
----------------------------------------
I think things are ready, though it's a very hefty PR:
https://github.com/apache/guacamole-manual/pull/165
I used the "Read the Docs" theme for Sphinx, and things look pretty nice when
built. For comparison, here's the main {{index.html}} page:
!guac-manual-sphinx-index.png|width=100%!
The LDAP docs:
!guac-manual-sphinx-ldap.png|width=100%!
The protocol reference:
!guac-manual-sphinx-proto.png|width=100%!
I've updated the {{README}} (now {{README.md}}) to describe the new build
process, which requires different dependencies but is otherwise still simply
running {{make}}. The {{Dockerfile}} has also been updated for the new build
process and makes things pretty easy to view.
> Migrate guacamole-manual away from DocBook
> ------------------------------------------
>
> Key: GUACAMOLE-1347
> URL: https://issues.apache.org/jira/browse/GUACAMOLE-1347
> Project: Guacamole
> Issue Type: Task
> Components: Documentation
> Reporter: Mike Jumper
> Assignee: Mike Jumper
> Priority: Major
> Fix For: 1.4.0
>
> Attachments: guac-manual-sphinx-index.png,
> guac-manual-sphinx-ldap.png, guac-manual-sphinx-proto.png
>
>
> In the interest of making the Guacamole documentation more approachable for
> contributors, the format of guacamole-manual should be migrated away from
> DocBook XML to a mainstream markup format that is closer to simply editing
> text (such as AsciiDoc, reStructuredText, or Markdown).
> See discussion on dev@:
> https://lists.apache.org/thread.html/r4be1d606d2d2209d08f4a0b89c978cff18b75a33685c5f4e126cc8bf%40%3Cdev.guacamole.apache.org%3E
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
