spring-cloud / spring-cloud/spring-cloud-build
Spring Cloud Stream Docs Not Being Aggregated Correctly
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 225
- Forks
- 295
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 14
Description
Spring Cloud Stream Docs are not being aggregated correctly when generating documentation.
http://cloud.spring.io/spring-cloud-static/Camden.SR4/#_spring_cloud_stream
When running ./release_train.sh --version Camden.SR4 --retrieveversions --ghpages
I see
asciidoctor: ERROR: loud-stream-docs/src/main/asciidoc/index.adoc: line 2: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
asciidoctor: ERROR: loud-stream-docs/src/main/asciidoc/index.adoc: line 24: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
asciidoctor: WARNING: loud-stream-docs/src/main/asciidoc/spring-cloud-stream-aggregate.adoc: line 1: include file not found: /Users/ryanjbaxter/git-repos/spring-cloud/scripts/docs/../stream/spring-cloud-stream-docs/core/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc
asciidoctor: ERROR: loud-stream-docs/src/main/asciidoc/spring-cloud-stream-aggregate.adoc: line 3: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
asciidoctor: WARNING: loud-stream-docs/src/main/asciidoc/spring-cloud-stream-aggregate.adoc: line 7: include file not found: /Users/ryanjbaxter/git-repos/spring-cloud/scripts/docs/../stream/spring-cloud-stream-docs/kafka/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc
asciidoctor: WARNING: loud-stream-docs/src/main/asciidoc/spring-cloud-stream-aggregate.adoc: line 11: include file not found: /Users/ryanjbaxter/git-repos/spring-cloud/scripts/docs/../stream/spring-cloud-stream-docs/rabbit/spring-cloud-stream-binder-rabbit-docs/src/main/asciidoc/overview.adoc
asciidoctor: WARNING: loud-stream-docs/src/main/asciidoc/spring-cloud-stream-aggregate.adoc: line 12: include file not found: /Users/ryanjbaxter/git-repos/spring-cloud/scripts/docs/../stream/spring-cloud-stream-docs/rabbit/spring-cloud-stream-binder-rabbit-docs/src/main/asciidoc/dlq.adoc
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with release_train.sh and the documentation aggregation inputs referenced in the error paths, then run ./release_train.sh --version Camden.SR4 --retrieveversions --ghpages. Trace why the Spring Cloud Stream overview, Kafka overview, Rabbit overview, and DLQ includes are missing; done means the command generates the aggregated documentation without the reported Asciidoctor errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell, spring
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100