GitHub user bhardesty opened a pull request:
https://github.com/apache/qpid-dispatch/pull/200
Add new book dir for dispatch router book; contribute doc improvements
This is the first step in some (hopefully helpful) improvements to the
Dispatch Router doc. I created a new, temporary `../doc/new-book` dir to
represent the new directory for the DR book (once the new book is ready to be
published, I'll archive or remove `/book` and change `/new-book` to `/book`).
Within `/new-book` I made the following enhancements:
- Added a new attributes file to hold all asciidoc doc attributes
- Added `/images` to hold all DR book images and added a bunch of new
diagrams for use in the book
- Created a new DR book from existing DR book content plus new task-based
chapters to cover things like configuration and management
- Edited the existing DR book content to use consistent asciidoc syntax and
apply doc attributes where appropriate
- Edited some of the existing DR book content for clarity
For now, you can use AsciiDoctor to build a preview of the new DR book
(`asciidoctor book.adoc`).
After this PR is merged, the next step will be to update the makefile to
build the new DR book (using AsciiDoctor) and change `/new-book` to `/book`.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/bhardesty/qpid-dispatch update-doc-dir
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/qpid-dispatch/pull/200.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #200
----
commit 0a89a302f79d9ded74508863f5c8ce31ca0a13a2
Author: Ben Hardesty <[email protected]>
Date: 2017-09-01T18:46:31Z
Add new book dir for dispatch router book; contribute doc improvements
----
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
