[
https://issues.apache.org/jira/browse/ARTEMIS-4383?focusedWorklogId=874243&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-874243
]
ASF GitHub Bot logged work on ARTEMIS-4383:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 02/Aug/23 10:56
Start Date: 02/Aug/23 10:56
Worklog Time Spent: 10m
Work Description: gemmellr commented on code in PR #4573:
URL: https://github.com/apache/activemq-artemis/pull/4573#discussion_r1281614512
##########
artemis-website/pom.xml:
##########
@@ -29,24 +29,20 @@
<properties>
<activemq.basedir>${project.basedir}/..</activemq.basedir>
- <webapp-dir>${project.artifactId}-${project.version}</webapp-dir>
-
<src-dir-user-manual>${basedir}/../docs/user-manual/en</src-dir-user-manual>
-
<scratch-dir-user-manual>${basedir}/target/scratch/user-manual</scratch-dir-user-manual>
-
<webapp-outdir-user-manual>${basedir}/target/classes/user-manual</webapp-outdir-user-manual>
-
<webapp-outdir-hacking-guide>${basedir}/target/classes/hacking-guide</webapp-outdir-hacking-guide>
-
<webapp-outdir-migration-guide>${basedir}/target/classes/migration-guide</webapp-outdir-migration-guide>
-
- <frontend-maven-plugin-version>1.12.1</frontend-maven-plugin-version>
- <nodeVersion>v18.15.0</nodeVersion>
- <npmVersion>9.6.2</npmVersion>
+
<asciidoctor.maven.plugin.version>2.2.4</asciidoctor.maven.plugin.version>
+ <asciidoctorj.pdf.version>2.3.9</asciidoctorj.pdf.version>
<skipWebsiteDocGeneration>false</skipWebsiteDocGeneration>
<skipWebsiteJavadocGeneration>false</skipWebsiteJavadocGeneration>
+ <skipWebsitePdfGeneration>false</skipWebsitePdfGeneration>
+
+ <!
Issue Time Tracking
-------------------
Worklog Id: (was: 874243)
Time Spent: 40m (was: 0.5h)
> 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: 40m
> 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)
