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

Fix build output directory for ref docs in CONTRIBUTING.md #26556

Merged
merged 1 commit into from
Feb 16, 2021

Conversation

cprayer
Copy link
Contributor

@cprayer cprayer commented Feb 16, 2021

/**
* Generate the Spring Framework Reference documentation from "src/docs/asciidoc"
* in "build/docs/ref-docs/html5".
*/
asciidoctor {
baseDirFollowsSourceDir()
configurations 'asciidoctorExt'
sources {
include '*.adoc'
}
outputDir "$buildDir/docs/ref-docs/html5"
logDocuments = true
resources {
from(sourceDir) {
include 'images/*.png', 'css/**', 'js/**'
}
from extractDocResources
}
}

(fd49c8f is latest commit of master branch)
As you can see, I think it should be build/docs/ref-docs/html5 directory, not a build/asciidoc/html5 directory.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Feb 16, 2021
@sbrannen sbrannen self-assigned this Feb 16, 2021
@sbrannen sbrannen added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Feb 16, 2021
@sbrannen sbrannen added this to the 5.3.5 milestone Feb 16, 2021
@sbrannen sbrannen changed the title Fix invalid build refdoc output directory in CONTRIBUTING.md Fix build output directory for ref docs in CONTRIBUTING.md Feb 16, 2021
@sbrannen sbrannen merged commit 7ca47cf into spring-projects:master Feb 16, 2021
@sbrannen
Copy link
Member

Good catch.

This has been merged into master.

Thanks

@cprayer cprayer deleted the fix-CONTRIBUTING-md branch February 17, 2021 00:40
This was referenced Mar 16, 2021
This was referenced Mar 17, 2021
lxbzmy pushed a commit to lxbzmy/spring-framework that referenced this pull request Mar 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants