[ 
https://issues.apache.org/jira/browse/ARTEMIS-5850?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Justin Bertram updated ARTEMIS-5850:
------------------------------------
    Description: 
Currently documentation for the web console is in 2 places:
* 
https://github.com/apache/artemis-website/tree/main/src/components/artemis-console/documentation
* 
https://github.com/apache/artemis/blob/main/docs/user-manual/management-console.adoc

Each set of documentation has information that the other set doesn't as well as 
significant overlap. This documentation should be consolidated with a 
preference for the AsciiDoc format since it's superior to Markdown in this 
context.

Also, the docs needs to be updated to account for new functionality and 
behavior introduced in recent versions.

  was:
Currently documentation for the web console is in 2 places:
* 
https://github.com/apache/artemis-website/tree/main/src/components/artemis-console/documentation
* 
https://github.com/apache/artemis/blob/main/docs/user-manual/management-console.adoc

Each set of documentation has information that the other set doesn't as well as 
significant overlap. This documentation should be consolidated with a 
preference for the AsciiDoc format since it's superior to Markdown in this 
context.


> Consolidate web console docs
> ----------------------------
>
>                 Key: ARTEMIS-5850
>                 URL: https://issues.apache.org/jira/browse/ARTEMIS-5850
>             Project: Artemis
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Justin Bertram
>            Assignee: Justin Bertram
>            Priority: Major
>
> Currently documentation for the web console is in 2 places:
> * 
> https://github.com/apache/artemis-website/tree/main/src/components/artemis-console/documentation
> * 
> https://github.com/apache/artemis/blob/main/docs/user-manual/management-console.adoc
> Each set of documentation has information that the other set doesn't as well 
> as significant overlap. This documentation should be consolidated with a 
> preference for the AsciiDoc format since it's superior to Markdown in this 
> context.
> Also, the docs needs to be updated to account for new functionality and 
> behavior introduced in recent versions.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to