search

rustyrazorblade / easy-cass-lab

Create Apache Cassandra lab environments in AWS
https://rustyrazorblade.com/
Other
11 stars 7 forks source link

Fix docs #11

Open rustyrazorblade opened 7 months ago

rustyrazorblade commented 7 months ago

There's asciidoctor documentation which should build to docs/, but I can't remember how it's regenerated. Need to figure that out and document it.

easy-cass-stress relies on a docker container to build the docs, probably best to just be consistent with that. 

version: '3'

services:
    pandoc:
        image: jagregory/pandoc
        volumes:
          - ./:/source
        command: -s --toc manual/MANUAL.md -o docs/index.html

    docs:
        image: asciidoctor/docker-asciidoctor

        volumes:
        - ./manual:/documents
        - ./docs:/html

        command: asciidoctor -o /html/index.html MANUAL.adoc -a EASY_CASS_STRESS_VERSION=${EASY_CASS_STRESS_VERSION}
rustyrazorblade commented 7 months ago

I'm not even sure if we need a full blown manual anymore.

rustyrazorblade commented 2 months ago

Took less than half a year for my last comment to age like milk. Yikes.

We definitely need a manual. I don't know if it needs to be in asciidoc. I prefer it, and the docs are there, so I'd like to find a good solution. It would be great if they could be hosted on GH, as a standalone site, and rebuilt automatically when docs are pushed. Also would be great if they were versioned.

rustyrazorblade commented 2 months ago

Related issue: https://github.com/asciidoctor/asciidoctor/issues/626

Looks like this can generate multi-page output: https://github.com/owenh000/asciidoctor-multipage