spring-cloud-release Creating documents from tests

Currently, the docs are built by a test (TestThatGeneratesTheFinalReleaseTrainDocumentationTests, which then calls another test method, which then calls GenerateReleaseTrainDocs).

We also have a bunch of Asciidoc content stored as .hsb files.

Maintaining the docs would be easier if the Asciidoc files were stored as .adoc files and built from an Asciidoctor task in the Maven build files.

Jun 03 '21 20:06 Buzzardo

@marcingrzejszczak will have to comment on the current setup

Jun 03 '21 22:06 spencergibb

That test is disabled https://github.com/spring-cloud/spring-cloud-release/blob/main/train-docs/src/test/java/org/springframework/cloud/internal/TestThatGeneratesTheFinalReleaseTrainDocumentationTests.java#L35 . We do the whole generation via maven tasks https://github.com/spring-cloud/spring-cloud-release/blob/main/pom.xml#L114-L119 and https://github.com/spring-cloud/spring-cloud-release/blob/main/train-docs/pom.xml#L52-L119 - nothing comes from the tests.

The .hsb documents are templates for which we generate the final adoc documentation. If you are able to rewrite our code from templated version to parametrized adoc then be my guest.

Jun 07 '21 07:06 marcingrzejszczak