Skip to content

docs(crd): fix NiFi authorization usage guide link (usage-guide -> usage_guide)#924

Open
MukundaKatta wants to merge 3 commits intostackabletech:mainfrom
MukundaKatta:codex/fix-authorization-usage-guide-link
Open

docs(crd): fix NiFi authorization usage guide link (usage-guide -> usage_guide)#924
MukundaKatta wants to merge 3 commits intostackabletech:mainfrom
MukundaKatta:codex/fix-authorization-usage-guide-link

Conversation

@MukundaKatta
Copy link
Copy Markdown

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:

  • `rust/operator-binary/src/crd/mod.rs`: fixed the rustdoc link used to generate the CRD description.
  • `extra/crds.yaml`: applied the same fix to the checked-in generated CRD so it stays in sync.
  • `CHANGELOG.md`: added an "Unreleased / Fixed" entry referencing this issue.

Closes #841

Testing

Documentation-only change. Verified:

…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
@stackable-cla
Copy link
Copy Markdown

stackable-cla Bot commented Apr 20, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Member

@xeniape xeniape left a comment

Choose a reason for hiding this comment

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

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 thread CHANGELOG.md Outdated
@xeniape
Copy link
Copy Markdown
Member

xeniape commented Apr 20, 2026

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.

@MukundaKatta
Copy link
Copy Markdown
Author

@xeniape Applied your changelog suggestion — pushed c9c24f5 reordering the PR link references ([#916], [#921], [#922], [#924]) as you had them.

On the CLA — I'll get it signed and post back once it's done. Thanks for the review!

@xeniape
Copy link
Copy Markdown
Member

xeniape commented Apr 22, 2026

Seems like the branch needs to resolve a small merge conflict, I can do that as well but didn't want to just meddle in your PR. Once that's done, I can approve 👍

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.

Incorrect link in NiFi CRD docs

2 participants