[
https://issues.apache.org/jira/browse/ARTEMIS-5850?focusedWorklogId=1001196&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1001196
]
ASF GitHub Bot logged work on ARTEMIS-5850:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 21/Jan/26 15:32
Start Date: 21/Jan/26 15:32
Worklog Time Spent: 10m
Work Description: jbertram commented on code in PR #158:
URL: https://github.com/apache/artemis-console/pull/158#discussion_r2713111264
##########
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:
Regarding testing...Don't we have some kind of "staging branch" that will
publish to a different sub-domain that we could use for this kind of testing?
In any case, I think that once the `.htaccess` is known to work then we can
trust that updating it appropriately won't break it.
That's a good point about the 301 vs 302 redirect. I'll fix that.
Regarding change history...Surely there's some git fu one could do to
achieve some functional equivalence here. For what it's worth, I've never
looked at the history for these files, although I often look at the history of
the raw AsciiDoc files in the main `artemis` repo.
I originally considered having a copy in both 'latest' and
'<latest-version>', but that violates my sensibilities. I really hope we can
avoid this. I've updated the docs a number of times post-release and would like
to avoid potentially having to do it in two places (although I agree this
_should_ be less likely with the console vs. the broker).
Issue Time Tracking
-------------------
Worklog Id: (was: 1001196)
Time Spent: 2.5h (was: 2h 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: 2.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]
