docs(crd): fix NiFi authorization usage guide link (usage-guide -> usage_guide)#924
Open
MukundaKatta wants to merge 1 commit intostackabletech:mainfrom
Open
Conversation
…age_guide) The `spec.clusterConfig.authorization` CRD doc in `rust/operator-binary/src/crd/mod.rs` linked to `nifi/usage-guide/security#authorization` (with a hyphen), which 404s. Every other usage-guide link in this repo and the docs uses an underscore, e.g. `nifi/usage_guide/security#authentication`. Also regenerated the rendered link in `extra/crds.yaml` and added a CHANGELOG entry. Closes stackabletech#841
|
|
xeniape
requested changes
Apr 20, 2026
Member
xeniape
left a comment
xeniape
left a comment
There was a problem hiding this comment.
LGTM thank you for opening a PR on this and fixing the broken link! :)
Just a small change request regarding the Changelog entry: The numbers actually reference the PRs not the issues
Comment on lines
+20
to
26
| - Fix broken link to the NiFi authorization usage guide in the `spec.clusterConfig.authorization` CRD doc (`usage-guide` -> `usage_guide`) ([#841]). | ||
|
|
||
| [#841]: https://github.com/stackabletech/nifi-operator/issues/841 | ||
| [#916]: https://github.com/stackabletech/nifi-operator/pull/916 | ||
| [#921]: https://github.com/stackabletech/nifi-operator/pull/921 | ||
| [#922]: https://github.com/stackabletech/nifi-operator/pull/922 | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| - Fix broken link to the NiFi authorization usage guide in the `spec.clusterConfig.authorization` CRD doc (`usage-guide` -> `usage_guide`) ([#924]). | |
| [#916]: https://github.com/stackabletech/nifi-operator/pull/916 | |
| [#921]: https://github.com/stackabletech/nifi-operator/pull/921 | |
| [#922]: https://github.com/stackabletech/nifi-operator/pull/922 | |
| [#924]: https://github.com/stackabletech/nifi-operator/pull/924 | |
Member
|
Could you also sign the CLA please? We need that to be able to accept the contribution ❤️ the link is in one of the above messages. |
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
2 participants
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.
Summary
The `spec.clusterConfig.authorization` CRD description links to the NiFi authorization usage guide using a hyphenated path:
```
https://docs.stackable.tech/home/stable/nifi/usage-guide/security#authorization
```
That URL 404s. Every other usage-guide link in this repo (`authentication`, `custom-components`, `extra-volumes`, `security`) uses `usage_guide` with an underscore, matching the actual docs path (`docs/modules/nifi/pages/usage_guide/security.adoc`).
Changes:
Closes #841
Testing
Documentation-only change. Verified: