Skip to content

Commit c6819a4

Browse files
authored
docs(crd): fix NiFi authorization usage guide link (usage-guide -> usage_guide) (#924)
* docs(crd): fix NiFi authorization usage guide link (usage-guide -> usage_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 #841 * fix(changelog): reference PR instead of issue
1 parent d93aaf0 commit c6819a4

3 files changed

Lines changed: 7 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,15 @@ All notable changes to this project will be documented in this file.
1616
Previously, arbitrary keys were silently accepted but ignored ([#921]).
1717
- Bump `stackable-operator` to 0.110.1 and `kube` to 3.1.0 ([#921]).
1818

19+
### Fixed
20+
21+
- Fix broken link to the NiFi authorization usage guide in the `spec.clusterConfig.authorization` CRD doc (`usage-guide` -> `usage_guide`) ([#924]).
22+
1923
[#903]: https://github.com/stackabletech/nifi-operator/pull/903
2024
[#916]: https://github.com/stackabletech/nifi-operator/pull/916
2125
[#921]: https://github.com/stackabletech/nifi-operator/pull/921
2226
[#922]: https://github.com/stackabletech/nifi-operator/pull/922
27+
[#924]: https://github.com/stackabletech/nifi-operator/pull/924
2328

2429
## [26.3.0] - 2026-03-16
2530

extra/crds.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ spec:
7171
singleUser: {}
7272
description: |-
7373
Authorization options.
74-
Learn more in the [NiFi authorization usage guide](https://docs.stackable.tech/home/nightly/nifi/usage-guide/security#authorization).
74+
Learn more in the [NiFi authorization usage guide](https://docs.stackable.tech/home/nightly/nifi/usage_guide/security#authorization).
7575
oneOf:
7676
- required:
7777
- opa

rust/operator-binary/src/crd/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ pub mod versioned {
129129
pub authentication: Vec<auth_core::v1alpha1::ClientAuthenticationDetails>,
130130

131131
/// Authorization options.
132-
/// Learn more in the [NiFi authorization usage guide](DOCS_BASE_URL_PLACEHOLDER/nifi/usage-guide/security#authorization).
132+
/// Learn more in the [NiFi authorization usage guide](DOCS_BASE_URL_PLACEHOLDER/nifi/usage_guide/security#authorization).
133133
#[serde(default)]
134134
pub authorization: NifiAuthorization,
135135

0 commit comments

Comments
 (0)