-
Notifications
You must be signed in to change notification settings - Fork 327
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
convert changelog and generate documentation in markdown format. #1161
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but I think we are going to find it harder to maintain the one single reference documentation file.
Is there any way to have individual per-product files that get combined into a single file with some pre/post processing when publishing?
this pr is rebased after #1164 merged in so that title level issues are addressed. |
Kudos, SonarCloud Quality Gate passed! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
If the two spring integration documentation parts (pub/sub and storage) become unwieldy in the future, we can split them up then.
…gleCloudPlatform#1161) * change CHANGELOG from asciidoc to markdown file. * produce documentation in markdown in separate folder. * remove image as it does not go through the pipeline. edit image path in doc. * replace spring_cloud_bus_over_pubsub image with link. * adding files to convert and assemble markdownfiles for each module. * remove all-in-one markdown doc. * fix list of file to convert and to include in doc. * adding md files per module. * copy title over to first-page.md * replace spring_cloud_bus_over_pubsub image with link. * remove yaml file to use with pandoc --defaults. use older syntax in script instead.
[updated.]
CHANGELOG.adoc
and replaced withCHANGELOG.md
.first-page.adoc
andconfiguration.adoc
(sections copied from index.adoc) so that result full doc can be concatenation of docs.docs/src/main/md/
spring-cloud-bus-pubsub.md
, replaced spring_cloud_bus_over_pubsub.png with link to github.Used
asciidoctor
andpandoc
to convert asciidoc to markdown.Steps to generate the markdown files: