[
https://issues.apache.org/jira/browse/ARTEMIS-4383?focusedWorklogId=874121&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-874121
]
ASF GitHub Bot logged work on ARTEMIS-4383:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 01/Aug/23 20:31
Start Date: 01/Aug/23 20:31
Worklog Time Spent: 10m
Work Description: jbertram commented on PR #4573:
URL:
https://github.com/apache/activemq-artemis/pull/4573#issuecomment-1661048472
If you want to peruse the new docs just pull down the branch and do the
following:
```sh
cd artemis-website
mvn clean package -Prelease -DskipWebsitePdfGeneration
```
The new User Manual will be in `target/user-manual`. Open `index.html` in
your browser.
Issue Time Tracking
-------------------
Worklog Id: (was: 874121)
Time Spent: 20m (was: 10m)
> Migrate user docs to AsciiDoc
> -----------------------------
>
> Key: ARTEMIS-4383
> URL: https://issues.apache.org/jira/browse/ARTEMIS-4383
> Project: ActiveMQ Artemis
> Issue Type: Task
> Reporter: Justin Bertram
> Assignee: Justin Bertram
> Priority: Major
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Markdown, which is currently used for user-facing documentation, is good for
> a lot of things. However, it's not great for the kind of complex
> documentation we have and our need to produce both multi-page HTML and
> single-page PDF output via Maven.
> Markdown lacks features which would make the documentation easier to read,
> easier to navigate, and just look better overall.
> The current tool-chain uses [honkit|https://github.com/honkit/honkit] and a
> tool called [Calibre|https://manual.calibre-ebook.com/]. Hokit is written in
> TypeScript and is installed via NPM. Calibre is a _native_ tool so it must be
> installed via an OS-specific package manager. All this complexity makes
> building, releasing, uploading, etc. a pain.
> AsciiDoc is relatively simple like Markdown, but it has more features for
> presentation and navigation not to mention Java-based Maven tooling to
> generate both HTML and PDF. Migrating will improve both the appearance of the
> documentation as well as the processes to generate and upload it.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
