Skip to content

Conversation

@avsej
Copy link
Member

@avsej avsej commented Aug 20, 2024

Install dependencies for preview generation:

brew install asciidoctor
gem install asciidoctor-diagram coderay
npm install -g @mermaid-js/mermaid-cli

Generate preview:

asciidoctor-pdf -r ascciidoctor-diagram modules/howtos/pages/migration-guide.adoc
open modules/howtos/pages/migration-guide.pdf

@avsej
Copy link
Member Author

avsej commented Aug 20, 2024

migration-guide.pdf
This is how the current draft looks like in PDF

@avsej avsej requested a review from RichardSmedley August 20, 2024 00:26
@avsej avsej marked this pull request as draft August 20, 2024 00:26
Install dependencies for preview generation:

    brew install asciidoctor
    gem install asciidoctor-diagram coderay
    npm install -g @mermaid-js/mermaid-cli

Generate preview:

    asciidoctor-pdf -r ascciidoctor-diagram modules/howtos/pages/migration-guide.adoc
    open modules/howtos/pages/migration-guide.pdf
@avsej
Copy link
Member Author

avsej commented Aug 20, 2024

Fixed some stylistic and grammar errors: migration-guide.pdf

@RichardSmedley
Copy link
Contributor

Thanks @avsej ,
I quite like this format.

What more do you think needs adding before we have an MVP we can edit and publish?

@avsej
Copy link
Member Author

avsej commented Aug 28, 2024

I think error handling and configuration are essential topics to cover in the first version, I will try to add them here soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants