Skip to content

Replace manual CRD docs generation step with a Hub verification step#859

Open
lfrancke wants to merge 4 commits into
mainfrom
docs/crd-step-to-hub
Open

Replace manual CRD docs generation step with a Hub verification step#859
lfrancke wants to merge 4 commits into
mainfrom
docs/crd-step-to-hub

Conversation

@lfrancke

@lfrancke lfrancke commented Jul 7, 2026

Copy link
Copy Markdown
Member

The Stackable Hub (hub.stackable.tech/crds) ingests operator CRDs automatically, replacing the old crds.stackable.tech browser generated from the crddocs repo.

In 06-release.md:

  • The "Generate CRD docs website" step is removed in favor of a "verify the release and its CRDs show up on the Hub" check
  • The [dt-2] link to the crddocs repo is removed.

lfrancke added 3 commits July 7, 2026 23:51
The Stackable Hub (hub.stackable.tech/crds) ingests operator CRDs
automatically, so the crds.stackable.tech generation step is obsolete.
Keep a lightweight checklist item to verify the new release showed up.
The Portal is the source of truth for release information; the Hub
displays it. Verifying the release on the Hub can only succeed after
the Portal has been updated.
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Jul 7, 2026
@lfrancke lfrancke self-assigned this Jul 7, 2026
Comment thread .github/ISSUE_TEMPLATE/06-release.md Outdated
- [ ] Set the release to "Released" in the Feature Tracker and create a new release (ping @lfrancke)
- [ ] Update the [getting-started page][dt-6] in the main docs and check it works with this release
- [ ] Update release information on the [Stackable Portal][dt-7] to reflect the now current release and history
- [ ] Verify the new release and its CRDs show up on the [Stackable Hub][dt-1]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The order of links is now out of order. We should either move this back to the first position again, or adjust the rest of the numbering.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Does the order really matter?
If you want to I can adjust it but...personally I ignored it on purpose :)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

And we made the links numbered in order on purpose when we created the issue. So we should stick with it.

Again, moving the checkbox to the top would fix this without much work.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Moving to the top doesn't make sense as we first need to update the portal. I'll change the numbers instead.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Renumbered the dt-N labels to match usage order (kept the Hub check after the Portal update, since the Portal feeds the Hub): the definitions are now dt-1dt-6 in the order they appear in the checklist.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@Techassi Techassi moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Jul 8, 2026
@lfrancke lfrancke requested a review from Techassi July 8, 2026 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: In Review

Development

Successfully merging this pull request may close these issues.

2 participants