Skip to content

Conversation

simionAndrei
Copy link
Contributor

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 #15991.

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-projects#15991.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 26, 2019
@snicoll snicoll self-assigned this Mar 29, 2019
@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Mar 29, 2019
@snicoll snicoll added this to the 2.2.0.M2 milestone Mar 29, 2019
snicoll pushed a commit that referenced this pull request Mar 29, 2019
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-16326
@snicoll snicoll closed this in 1bc47b7 Mar 29, 2019
snicoll added a commit that referenced this pull request Mar 29, 2019
* pr/16326:
  Polish "Add Spring-specific styling to Actuator's API documentation"
  Use asciidoctor 1.5.8
  Add Spring-specific styling to Actuator's API documentation
@snicoll
Copy link
Member

snicoll commented Mar 29, 2019

@simionAndrei thank you for making your first contribution to Spring Boot. This is now merged on master with a polish commit as no docs zip was generated anymore. This also exposed a bug in asciidcotor that was fixed in 1.5.8 so I upgraded to it as well.

@snicoll
Copy link
Member

snicoll commented Apr 2, 2019

My polish broke deployment as there is now an extra reference directory in the generated zip: reopening to investigate and fix that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Spring-specific styling to the Actuator's API documentation
3 participants