Add Asciidoctor Web PDF #244

diguage · 2022-03-06T14:28:26Z

The PR contains two changes:

Asciidoctor Web PDF is a great tool. So I add Asciidoctor Web PDF.
Demo of some useful tips for using Asciidoc on GitHub -- show the admonitions as icons. So, I add some variables:

ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]

dduportal · 2022-03-06T14:46:42Z

Hi @diguage thanks for the contribution. Is there an issue that could help us (maintainers) to understand a bit better the "why/what/how" of this PR please?

A few feedback at first:

You removed the README.md while there is a reason why we added it (DockerHub does not support asciidoctor so the CI process keeps it up to date from the README.adoc). Could you please add it back?
Could you add a test case for this addon, that would help a lot?

dduportal

Some important feedback to allow this PR to land (version tracking is mandatory)

dduportal · 2022-03-06T14:47:38Z

Dockerfile

@@ -100,7 +102,8 @@ RUN apk add --no-cache \
    tzdata \
    unzip \
    which \
-    font-noto-cjk
+    font-noto-cjk \
+    nodejs


What is the version of nodejs used here? Could you fix it and add an updatecli manifest (in ./updatecli/updatecli.d/) to track its version please?

Could you share, in the PR description, the additional size resulting with this change (the image is already quite heavy)?

OK, let me try it. I do not know how to do it(the updatecli manifest), give me some time.

No problem: it is not very well documented on the contributing section so there is no strong expectations.
My message was to let you know that it is needed but I may help.
I suggest that you try by checking the existing manifests.

I updated the code. But it is not the final work. Give me some time.

I updated the code to add a test case and manifest for Node.js. Please check it. If it has some errors, please help me to update it.

I tried to build it many times but it always threw errors. Please help me to check the additional size resulting with this change. Thanks.

WDYT about using a Multi stage build with the official NodeJS image (instead of instaling the nodejs package) in which you install the NPM packages, and you retrieve only the required directories/files (explained in https://medium.com/geekculture/how-to-install-a-specific-node-js-version-in-an-alpine-docker-image-3edc1c2c64be for a "pure" NodeJS installation).

It would allow faster builds (node js / npm run in parallel of the rest), and a fixed controlled version of nodejs.

Let me try it.

Dockerfile

README.adoc

mojavelinux · 2022-03-07T00:50:48Z

This issue is related to #183. Please see my comment there.

Dockerfile

updatecli/updatecli.d/nodejs.yml

diguage · 2022-03-07T02:48:26Z

README.md

@@ -28,6 +28,8 @@ This Docker image provides:

 -   [Asciidoctor Kroki](https://github.com/Mogztter/asciidoctor-kroki) 0.5.0

+-   [Asciidoctor Web PDF](https://github.com/Mogztter/asciidoctor-web-pdf) 1.0.0-alpha.14  -- This is an unofficial project.


@mojavelinux I add the description: This is an unofficial project. . Is it OK?

diguage · 2022-03-07T02:48:57Z

README.adoc

@@ -34,6 +43,7 @@ This Docker image provides:
 * https://github.com/asciidoctor/asciidoctor-confluence[Asciidoctor Confluence] {ASCIIDOCTOR_CONFLUENCE_VERSION}
 * https://github.com/asciidoctor/asciidoctor-bibtex[Asciidoctor Bibtex] {ASCIIDOCTOR_BIBTEX_VERSION}
 * https://github.com/Mogztter/asciidoctor-kroki[Asciidoctor Kroki] {ASCIIDOCTOR_KROKI_VERSION}
+* https://github.com/Mogztter/asciidoctor-web-pdf[Asciidoctor Web PDF] {ASCIIDOCTOR_WEB_PDF_VERSION} -- This is an unofficial project.


@mojavelinux I add the description: This is an unofficial project. . Is it OK?

diguage

Please help me to check or update the test case and the updatecli manifest. Thanks a lot.

updatecli/updatecli.d/nodejs.yml

dduportal · 2022-03-20T18:16:48Z

Dockerfile

@@ -12,6 +12,9 @@ ARG asciidoctor_revealjs_version=4.1.0
 ARG kramdown_asciidoc_version=2.0.0
 ARG asciidoctor_bibtex_version=0.8.0
 ARG asciidoctor_kroki_version=0.5.0
+ARG nodejs_version=16.14.0-r0
+ARG asciidoctor_web_pdf_version=1.0.0-alpha.14
+ARG asciidoctor_kroki_npm_version=0.15.4


what is the reason to add this element (since kroki is already installed)?

Asciidoctor Kroki has two versions: for Ruby and for Node.js. Asciidoctor Kroki for Ruby was installed. But Asciidoctor Kroki for Node.js is not installed.

Gotcha, thanks for the explanation! In that case we'll have to track the version of this component as well with an updatecli manifest :) (yea it's cumbersome but the goal is ensure that control what is inside this image to avoid supply chain issues)

Co-authored-by: Damien Duportal <damien.duportal@gmail.com>

dduportal requested changes Mar 6, 2022

View reviewed changes

Add Asciidoctor Web PDF

947c711

diguage force-pushed the web-pdf branch from 576fdfd to 947c711 Compare March 6, 2022 15:59

dduportal self-requested a review March 6, 2022 16:05

diguage force-pushed the web-pdf branch from 9a9a1c3 to 783d702 Compare March 7, 2022 01:14

mojavelinux reviewed Mar 7, 2022

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

add test case and manifest for Node.js

b75747b

diguage force-pushed the web-pdf branch from 783d702 to b75747b Compare March 7, 2022 02:43

diguage commented Mar 7, 2022

View reviewed changes

updatecli/updatecli.d/nodejs.yml Outdated Show resolved Hide resolved

diguage commented Mar 7, 2022

View reviewed changes

dduportal reviewed Mar 20, 2022

View reviewed changes

updatecli/updatecli.d/nodejs.yml Outdated Show resolved Hide resolved

dduportal reviewed Mar 20, 2022

View reviewed changes

Update updatecli/updatecli.d/nodejs.yml

feab231

Co-authored-by: Damien Duportal <damien.duportal@gmail.com>

dduportal added the asciidoctor-box label May 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Asciidoctor Web PDF #244

Add Asciidoctor Web PDF #244

diguage commented Mar 6, 2022 •

edited

dduportal commented Mar 6, 2022

dduportal left a comment

dduportal Mar 6, 2022

diguage Mar 6, 2022

dduportal Mar 6, 2022

diguage Mar 6, 2022

diguage Mar 7, 2022

dduportal Mar 20, 2022

diguage Mar 20, 2022

mojavelinux commented Mar 7, 2022

diguage Mar 7, 2022

diguage Mar 7, 2022

diguage left a comment •

edited

dduportal Mar 20, 2022

diguage Mar 20, 2022

dduportal Mar 21, 2022

		@@ -28,6 +28,8 @@ This Docker image provides:

		- [Asciidoctor Kroki](https://github.com/Mogztter/asciidoctor-kroki) 0.5.0

		- [Asciidoctor Web PDF](https://github.com/Mogztter/asciidoctor-web-pdf) 1.0.0-alpha.14 -- This is an unofficial project.

Add Asciidoctor Web PDF #244

Are you sure you want to change the base?

Add Asciidoctor Web PDF #244

Conversation

diguage commented Mar 6, 2022 • edited

dduportal commented Mar 6, 2022

dduportal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mojavelinux commented Mar 7, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diguage left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diguage commented Mar 6, 2022 •

edited

diguage left a comment •

edited