Repository navigation
chore(docs): add frontend migration guides - #5009
Merged
openshift-merge-bot[bot] merged 3 commits intoJul 1, 2026
Merged
Conversation
Contributor
|
The container image build workflow finished with status: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5009 +/- ##
=======================================
Coverage 55.39% 55.39%
=======================================
Files 122 122
Lines 2365 2365
Branches 539 564 +25
=======================================
Hits 1310 1310
Misses 1049 1049
Partials 6 6
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Contributor
This change adds a couple migration guides to help plugin developers and RHDH operators better understand the changes required to adopt the new frontend system once it's made the default in RHDH. Assisted-By: Cursor Desktop
Contributor
gashcrumb
changed the title
5 tasks done
- Fix drawer section: AppDrawerContentBlueprint exists in RHDH (not "pending NFS design") - Add translation module pluginId: 'app' requirement - Add API breaking changes (param renames, makeWithOverrides deprecation) - Add 3 common gotchas (defineParams wrapper, double headers, default export) - Add reference migration PRs table (8 rhdh-plugins PRs) - Add dev app setup for Phase 3 validation Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…hanges docs: add gotchas, API changes, drawer blueprint, and reference PRs
|
openshift-merge-bot
Bot
merged commit Jul 1, 2026
a1a8bf9
into
redhat-developer:main
21 checks passed
gustavolira
added a commit
to gustavolira/rhdh
that referenced
this pull request
Sep 11, 2026
`markdown-link-check` has failed on every PR since 2026-09-10. Not because of anything those PRs changed — it scans the whole repo — but because redhat-developer#5360 bumped the action from v1.1.2 to v1.1.3 the day before, and the newer version checks in-file anchors. What it found is real. The three anchors point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. The links omit it, which means they have been going nowhere on GitHub since the guides landed in July (redhat-developer#5009). Verified with github-slugger rather than reasoned about. backstage.io/docs/reference/filter-predicates is a genuine 404 with no successor I could find, so the link goes and the sentence keeps its wording rather than pointing somewhere invented. The one false positive is docs.redhat.com, which bot-blocks the checker: 302 with no user agent, 403 with a browser one, on URLs that open fine. It joins the two Red Hat hosts already in ignorePatterns for the same reason. Verified by running markdown-link-check with the repo's own config over each affected file: all exit 0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
gustavolira
added a commit
to gustavolira/rhdh
that referenced
this pull request
Sep 11, 2026
`markdown-link-check` has failed on every PR since 2026-09-10. Not because of anything those PRs changed — it scans the whole repo — but because redhat-developer#5360 bumped the action from v1.1.2 to v1.1.3 the day before, and the newer version checks in-file anchors. What it found is real. The three anchors point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. The links omit it, which means they have been going nowhere on GitHub since the guides landed in July (redhat-developer#5009). Verified with github-slugger rather than reasoned about. It is the only heading in docs/ that falls into this trap. backstage.io/docs/reference/filter-predicates is a genuine 404 with no successor I could find, so the link goes and the sentence keeps its wording rather than pointing somewhere invented. docs.redhat.com is the one false positive, and it is intermittent rather than a flat block: the two URLs that failed in CI answer 200 from a workstation, and answered 302/403 an hour earlier. The site rate-limits automated callers, and the existing retry settings only cover 429, not 403. Ignoring the domain is the pragmatic fix, at the cost of no longer checking the six docs.redhat.com links in the repo — the other four are passing today and would lose coverage. Verified by running markdown-link-check with the repo's own config over each affected file: all exit 0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
gustavolira
added a commit
to gustavolira/rhdh
that referenced
this pull request
Sep 11, 2026
`markdown-link-check` has failed on every PR since 2026-09-10. Not because of anything those PRs changed — it scans the whole repo — but because redhat-developer#5360 bumped the action from v1.1.2 to v1.1.3 the day before, and the newer version checks in-file anchors. What it found is real. The three anchors point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. The links omit it, which means they have been going nowhere on GitHub since the guides landed in July (redhat-developer#5009). Verified with github-slugger rather than reasoned about. It is the only heading in docs/ that falls into this trap. backstage.io/docs/reference/filter-predicates is a genuine 404 with no successor I could find, so the link goes and the sentence keeps its wording rather than pointing somewhere invented. docs.redhat.com is the one false positive, and it is intermittent rather than a flat block: the two URLs that failed in CI answer 200 from a workstation, and answered 302/403 an hour earlier. The site rate-limits automated callers, and the existing retry settings only cover 429, not 403. Ignoring the domain is the pragmatic fix, at the cost of no longer checking the six docs.redhat.com links in the repo — the other four are passing today and would lose coverage. Verified by running markdown-link-check with the repo's own config over each affected file: all exit 0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
gustavolira
added a commit
to gustavolira/rhdh
that referenced
this pull request
Sep 11, 2026
`markdown-link-check` has failed on every PR since 2026-09-10, against content none of those PRs touched — it scans the whole repo. redhat-developer#5360 bumped the action from v1.1.2 to v1.1.3 the day before and the newer version checks in-file anchors, which is what surfaced the first batch. Anchors. Three links point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. They have been going nowhere on GitHub since the guides landed in July (redhat-developer#5009). Verified with github-slugger; it is the only heading in docs/ with this shape. Pages that moved upstream: - backstage.io/docs/reference/filter-predicates -> the generated API reference (thanks Hope for finding it) - backstage.io/docs/reference/core-plugin-api.apptheme -> the module page, the hand-written reference page is gone - docs.ci.openshift.org/docs/architecture/prow -> /docs/architecture - community-plugins redhat-argocd -> argocd, renamed in their #6820 - community-plugins github-actions, github-issues and github-pull-requests-board -> all under one github workspace after their #7507 - gajus/global-agent test files -> the repo root; neither path exists on master or main any more Things that no longer exist here: - values_showcase-auth-providers.yaml was deleted in redhat-developer#4458, and the bullet above it already says that job deploys with the Operator rather than Helm, so the whole bullet goes - github-discovery.spec.ts is gone; the auth-providers suites are what use fixtures today Rate-limited hosts, not dead links: docs.redhat.com, developers.redhat.com and devservices.dpp.openshift.com answer 200 or resolve from a workstation and 403 or 0 from CI. The existing retry settings only cover 429. They join the two Red Hat hosts already in ignorePatterns, at the cost of no longer checking the handful of links behind them. Verified by running markdown-link-check with the repo's own config over docs/ and the root markdown, the two sets the workflow checks: both clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
kim-tsao
pushed a commit
that referenced
this pull request
Sep 14, 2026
* fix(docs): repair three broken anchors and one dead link `markdown-link-check` has failed on every PR since 2026-09-10. Not because of anything those PRs changed — it scans the whole repo — but because #5360 bumped the action from v1.1.2 to v1.1.3 the day before, and the newer version checks in-file anchors. What it found is real. The three anchors point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. The links omit it, which means they have been going nowhere on GitHub since the guides landed in July (#5009). Verified with github-slugger rather than reasoned about. It is the only heading in docs/ that falls into this trap. backstage.io/docs/reference/filter-predicates is a genuine 404 with no successor I could find, so the link goes and the sentence keeps its wording rather than pointing somewhere invented. docs.redhat.com is the one false positive, and it is intermittent rather than a flat block: the two URLs that failed in CI answer 200 from a workstation, and answered 302/403 an hour earlier. The site rate-limits automated callers, and the existing retry settings only cover 429, not 403. Ignoring the domain is the pragmatic fix, at the cost of no longer checking the six docs.redhat.com links in the repo — the other four are passing today and would lose coverage. Verified by running markdown-link-check with the repo's own config over each affected file: all exit 0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(docs): repair the dead links across docs and README `markdown-link-check` has failed on every PR since 2026-09-10, against content none of those PRs touched — it scans the whole repo. #5360 bumped the action from v1.1.2 to v1.1.3 the day before and the newer version checks in-file anchors, which is what surfaced the first batch. Anchors. Three links point at ### Adding application drawers (`application/internal/drawer-*`) whose slug keeps the hyphen before the asterisk and so ends in one. They have been going nowhere on GitHub since the guides landed in July (#5009). Verified with github-slugger; it is the only heading in docs/ with this shape. Pages that moved upstream: - backstage.io/docs/reference/filter-predicates -> the generated API reference (thanks Hope for finding it) - backstage.io/docs/reference/core-plugin-api.apptheme -> the module page, the hand-written reference page is gone - docs.ci.openshift.org/docs/architecture/prow -> /docs/architecture - community-plugins redhat-argocd -> argocd, renamed in their #6820 - community-plugins github-actions, github-issues and github-pull-requests-board -> all under one github workspace after their #7507 - gajus/global-agent test files -> the repo root; neither path exists on master or main any more Things that no longer exist here: - values_showcase-auth-providers.yaml was deleted in #4458, and the bullet above it already says that job deploys with the Operator rather than Helm, so the whole bullet goes - github-discovery.spec.ts is gone; the auth-providers suites are what use fixtures today Rate-limited hosts, not dead links: docs.redhat.com, developers.redhat.com and devservices.dpp.openshift.com answer 200 or resolve from a workstation and 403 or 0 from CI. The existing retry settings only cover 429. They join the two Red Hat hosts already in ignorePatterns, at the cost of no longer checking the handful of links behind them. Verified by running markdown-link-check with the repo's own config over docs/ and the root markdown, the two sets the workflow checks: both clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This change adds a couple migration guides to help plugin developers and RHDH operators better understand the changes required to adopt the new frontend system once it's made the default in RHDH.
Assisted-By: Cursor Desktop
Which issue(s) does this PR fix
PR acceptance criteria
Please make sure that the following steps are complete:
How to test changes / Special notes to the reviewer