Add Spring-specific styling to Gradle Plugin's documentation #16327
Conversation
spring-projects-issues
added
the
status: waiting-for-triage
There was a problem hiding this comment.
Thanks for opening your first PR.
The change to single file to multiple files broke the creation of the zip that does not contain the documentation anymore. I've just pushed a similar polish for the actuator doc. Would you mind taking a look and update your PR so that the ZIP contains the same content?
Also, I question the creation of attributes.adoc as part of this PR and would like that change to be reverted unless absolutely necessary for the task at hand.
Thanks!
spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/asciidoc/index.adoc
Outdated
Show resolved
Hide resolved
snicoll
added
type: documentation
This commit replaces the default Asciidoctor styling with Spring specific styling. First, we need to unzip the contents of the Spring Asciidoctor documentation resources provided by the `io.spring.docsresources:spring-docs-resources` distribution zip. This is done in a `/target/refdocs` folder. We then copy all files from `src/main/asciidoc` to the same location, and then launch the generation process. Closes spring-projectsgh-15990
This commit will put adoc attributes back to index.adoc and fix the issue where documentation was not properly packaged into a zip file. Closes spring-projectsgh-16327
snicoll
removed
the
status: waiting-for-feedback
This commit replaces the default Asciidoctor styling with Spring specific styling. First, we need to unzip the contents of the Spring Asciidoctor documentation resources provided by the `io.spring.docsresources:spring-docs-resources` distribution zip. This is done in a `/target/refdocs` folder. We then copy all files from `src/main/asciidoc` to the same location, and then launch the generation process. See gh-16327
* pr/16327: Polish "Add Spring-specific styling to Gradle Plugin's documentation" Add Spring-specific styling to Gradle Plugin's documentation
|
@hsellik Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
|
@hsellik it looks like you haven't signed the CLA. Please sign it ASAP or we'll have to revert this contribution. |
|
Thanks Andy. That PR was flagged as first time contributor and I did ask rob to check our records first so something must be different (different email address?) |
|
They both use the same email address as far as I can tell. Perhaps the bot has been confused by all the other commits on #16182 and it's generated a false positive there for it having been signed. |
|
@hsellik Thank you for signing the Contributor License Agreement! |
Oh, sorry. The reason was that I changed my GitHub username. Didn't think it will have this effect. @wilkinsona |
Yeah that's probably it. Thanks for signing the CLA in any case. |
No need, I just synced the PR and you're all set. Thanks for your contributions so far! |
This commit replaces the default Asciidoctor styling with
Spring specific styling.
First, we need to unzip the contents of the Spring Asciidoctor
documentation resources provided by the
io.spring.docsresources:spring-docs-resourcesdistribution zip. Thisis done in a
/target/refdocsfolder. We then copy all files fromsrc/main/asciidocto the same location, and then launch the generationprocess.
Closes gh-15990