Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creating documents from tests #226

Open
Buzzardo opened this issue Jun 3, 2021 · 2 comments
Open

Creating documents from tests #226

Buzzardo opened this issue Jun 3, 2021 · 2 comments

Comments

@Buzzardo
Copy link

Buzzardo commented Jun 3, 2021

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.

@spencergibb
Copy link
Member

@marcingrzejszczak will have to comment on the current setup

@marcingrzejszczak
Copy link
Contributor

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.

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

No branches or pull requests

3 participants