You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@activemq.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/06/05 20:16:01 UTC
[jira] [Commented] (ARTEMIS-1912) Review Documentation
[ https://issues.apache.org/jira/browse/ARTEMIS-1912?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16502424#comment-16502424 ]
ASF GitHub Bot commented on ARTEMIS-1912:
-----------------------------------------
GitHub user jbertram opened a pull request:
https://github.com/apache/activemq-artemis/pull/2123
ARTEMIS-1912 big doc refactor
- Split protocols into individual chapters
- Reorganize summary to flow more logically
- Fill in missing parameters in configuration index
- Normalize spaces for ordered and unordered lists
- Re-wrap lots of text for readability
- Fix incorrect XML snippets
- Normalize table formatting
- Improve internal links with anchors
- Update content to reflect new address model
- Resized architecture images to avoid excessive white-space
- Update some JavaDoc
- Update some schema elements
- Disambiguate AIO & ASYNCIO where necessary
- Use URIs instead of Objects in code examples
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jbertram/activemq-artemis ARTEMIS-1912
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/activemq-artemis/pull/2123.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 #2123
----
commit 1965f2dd074e8ad5945622d8ca400443f4b53823
Author: Justin Bertram <jb...@...>
Date: 2018-03-09T15:07:38Z
ARTEMIS-1912 big doc refactor
- Split protocols into individual chapters
- Reorganize summary to flow more logically
- Fill in missing parameters in configuration index
- Normalize spaces for ordered and unordered lists
- Re-wrap lots of text for readability
- Fix incorrect XML snippets
- Normalize table formatting
- Improve internal links with anchors
- Update content to reflect new address model
- Resized architecture images to avoid excessive white-space
- Update some JavaDoc
- Update some schema elements
- Disambiguate AIO & ASYNCIO where necessary
- Use URIs instead of Objects in code examples
----
> Review Documentation
> --------------------
>
> Key: ARTEMIS-1912
> URL: https://issues.apache.org/jira/browse/ARTEMIS-1912
> Project: ActiveMQ Artemis
> Issue Type: Task
> Reporter: Justin Bertram
> Assignee: Justin Bertram
> Priority: Major
>
> Despite a number of recent documentation updates the documentation overall is a bit of a mess with inconsistent formatting and missing/outdated information. These issues need to be addressed.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)