[
https://issues.apache.org/jira/browse/ARTEMIS-5850?focusedWorklogId=1000465&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1000465
]
ASF GitHub Bot logged work on ARTEMIS-5850:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 16/Jan/26 11:48
Start Date: 16/Jan/26 11:48
Worklog Time Spent: 10m
Work Description: gemmellr commented on PR #6182:
URL: https://github.com/apache/artemis/pull/6182#issuecomment-3759680679
Not entirely sure about this consolidation direction as opposed to for
example the reverse. The reason the new consoles docs were prepared outwith the
Artemis build is that it can be used separately and it is released/updated
separately, so it made sense that its docs should be able to be updated
separately with its release as well. Arguably the broker docs that this change
is overhauling should have been minimised further at that point and referenced
out to the console docs (which would ideally also have been version-specific to
facilitate that better, and perhaps in the console tree to be updated as
changes are made to the console).
Going this way, any time we make significant changes in a console release
that should really be documented we then either have to just leave the console
docs stale when releasing, or duplicate [some part of] this content back there
to do it, since we couldnt update these docs on the site until after the next
Artemis release (even if we did it manually out of band on the site, since they
would then be incorrect for the current released Artemis version). For
admittedly unusual reasons its taken us over 2 months since 1.4.0 was released,
and in the end we skipped it for embedding with the broker, but will still be
over a week between 1.5.0 and 2.50.0 going out.
Issue Time Tracking
-------------------
Worklog Id: (was: 1000465)
Time Spent: 0.5h (was: 20m)
> 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
> Labels: pull-request-available
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> 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]
