GitHub user bhardesty opened a pull request:
https://github.com/apache/qpid-dispatch/pull/336
No JIRA: Propose doc contribution guidelines for Dispatch Router
This PR adds (hopefully) helpful information for anyone interested in
making a contribution to the Dispatch Router doc, including:
* Improved README for the docs/ dir that describes the organization of the
directory, and how to contribute to and build the docs
* New doc contribution guide (under docs/notes/) that explains how to make
either a simple or complex contribution to the Dispatch Router user guide
* New style guide (under docs/notes/) that provides some simple style
guidelines to keep in mind when writing doc
I'd also like to add templates to use for complex doc contributions (one
each for writing a procedure, a concept, or a reference); those will come in a
future PR.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/bhardesty/qpid-dispatch doc-contribution
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/qpid-dispatch/pull/336.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 #336
----
commit 257dda31574db0c29d305e6c506a059a7986ffcf
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-23T20:56:59Z
First pass at new doc readme
commit b35b543f7ad33a795f8895fa899d47465c549edd
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-27T20:26:00Z
Write large doc contribution procedures
commit 0e9f4a7cccb719efbdae4de66dff56ecc59728f3
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-28T21:40:57Z
Add internal resources for writing doc
commit 05a5a52a8e93321d397ef8abee32932bd4757c46
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-29T18:55:00Z
Create readmes for user guide and man page dirs
commit 87464f9ed811464c3e97aca2fe731179bcc3cf2d
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-29T19:01:21Z
Add reference to qdrouterd.conf man page
commit bbe8cb60dac63d0fcf51ff38495ec976c285b994
Author: Ben Hardesty <bhardest@...>
Date: 2018-03-29T19:21:19Z
Add doc style guide
commit 736ced4baeda89fdc2dbb27205b02422831371f8
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:37:10Z
Add new doc contrib resources to new docs dir structure
commit 0dcd515b736d2cc6449acc3ae4e97975fcb977c0
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:37:57Z
Really add doc contrib resources
commit 1c9a8fc8858cc6db35c3b3d2602dda2ee0d1ca5a
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:42:12Z
Remove old doc resources under old doc dir
commit 5ad1f03ad3b5d11309831aa16df5ac72c586953f
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:43:18Z
Remove old docs readme
commit 0963670af2b82427278d166d3a0b1f7469e43993
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:51:22Z
Misc minor fixes to doc contrib resources
commit 453d3ffc20fb77eeaf509cd2ce5812f1dff4f1c6
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:54:22Z
Fix link and styling issue
commit fed25a0438935e37ea8e3a9bb28922a1c8cbad7e
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-28T15:55:35Z
Fix styling issue
commit 4577952f5592c7fb9c6494451aba1d6c6a869dc2
Author: Ben Hardesty <bhardest@...>
Date: 2018-06-29T16:03:08Z
Fix numbering issue
----
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
