[
https://issues.apache.org/jira/browse/ARTEMIS-5850?focusedWorklogId=1001210&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1001210
]
ASF GitHub Bot logged work on ARTEMIS-5850:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 21/Jan/26 16:57
Start Date: 21/Jan/26 16:57
Worklog Time Spent: 10m
Work Description: gemmellr commented on code in PR #158:
URL: https://github.com/apache/artemis-console/pull/158#discussion_r2713486583
##########
Releasing.md:
##########
@@ -179,20 +178,21 @@ Once the CDN and Maven Central are up-to-date then update
the site as follows:
1. Run the release addition script to generate/perform most of the updates by
running command of form:
```
-./scripts/release/add-artemis-console-release.sh <new-version>
+./scripts/release/add-artemis-console-release.sh <path.to>/artemis-console
<previous-version> <new-version>
```
This does the following:
- Creates the new release collection file at
`src/_artemis_console_releases/artemis-console-<padded-version-string>.md`.
- Creates the new release notes file at
`src/components/artemis-console/download/release-notes-<new-version>.md`.
+- Creates a new directory for the documentation at
`src/components/artemis-console/documentation/<new-version>` and copies the
documentation into it from the build directory.
+- Updates `.htaccess` file in `src/components/artemis-console/documentation`
to properly reference the "latest" docs.
Review Comment:
I did think of an alternative that gives both a 'latest' dir and
version-specific dirs the broker documentation can immediately reference...do
the reverse of what this is currently doing. Use a stable 'latest' dir for the
current docs, and redirect from \<latest-version-number\> --> latest. The 'add
release script' then updates the redirect, and copies the old docs to the old
version dir.
Issue Time Tracking
-------------------
Worklog Id: (was: 1001210)
Time Spent: 3h (was: 2h 50m)
> 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: 3h
> 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]
