Skip to content

Point the site start page at the streaming component - #6

Merged
JakeSCahill merged 1 commit into
mainfrom
docs/fix-start-page
Oct 19, 2026
Merged

JakeSCahill merged 1 commit into
mainfrom
docs/fix-start-page

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

The playbook's site.start_page is ROOT:get-started:intro-to-events.adoc, but the docs repo's component is now named streaming, so every build warns Start page specified for site not found. New repos copy this playbook, so the warning spreads. Found by @Feediver1 while reviewing #5.

The docs repo's component is named streaming, not ROOT, so the build
warned that the start page was not found.
@JakeSCahill
JakeSCahill requested a review from a team as a code owner October 9, 2026 18:18
@Feediver1

Copy link
Copy Markdown
Contributor

Technical check: point the site start page at the streaming component

Overall: Correct and ready to merge.

  • The docs repo's antora.yml is name: streaming on main (26.2) and beta (26.3), and modules/get-started/pages/intro-to-events.adoc exists. Without a version, streaming:get-started:intro-to-events.adoc resolves to the latest stable version, which is what a start page should do.

Follow-up (not for this PR)

  • New repos copy this playbook, and it includes aggregate-terms, but it doesn't pull in docs-site's home component. Once docs-extensions-and-macros#370 ships and docs-site#264 merges, new repos would start out with no glossary to link to. Consider adding the docs-site source (start_paths: [home, …]) and glossarypage: home:ROOT:glossary.adoc. Also, package-lock.json resolves the latest dependency to 3.7.0, so copied repos start on a very old release.

@JakeSCahill
JakeSCahill requested a review from Feediver1 October 14, 2026 10:19

@Feediver1 Feediver1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-standards review, second pass (head 1df695a)

No merge-blockers. It's ready to merge and only needs an approval. Nothing has changed since my 10/13 check. streaming:get-started:intro-to-events.adoc resolves to the latest stable Streaming version, and this fixes the Start page specified for site not found warning that new repos inherit.

My 10/13 follow-up (pulling in the home component and the glossary setting) is now #7. The two PRs edit different parts of local-antora-playbook.yml, so they don't conflict, and they can merge in either order.

@JakeSCahill
JakeSCahill merged commit 9df5d0d into main Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants