Spring Cloud Stream Docs Not Being Aggregated Correctly
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- shell, spring
- Domain
- build-system, documentation
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.
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
- Dominant language
- Shell
- Stars
- 225
- Forks
- 295
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 14
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.
More from spring-cloud/spring-cloud-build
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
waiting-for-triage
Difficulty 3/5 1-2 days Newbie friendliness 42/100
spring-cloud/spring-cloud-build#236 · 1 comment ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
spring-cloud/spring-cloud-build#195 · 3 comments ·
-
task
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
All issues in spring-cloud/spring-cloud-build
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·
-
docs(agents): strengthen the no-backslash-escaped-backticks rule with an issue-creation example Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
technical-debt
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ll7/robot_sf_ll7#9560 ·
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
oSoWoSo/vOid_Community_repOsitory#148 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100