Improve CRD documention #263
Merged
Conversation
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
|
I would also suggest adding some documentation about required/optional fields, immutable fields, and ranges, as this information can only be get by actually applying CRs. |
|
In addition to my other suggestion, I would also provide example values for some fields. This can be omitted if we have samples already containing all the necessary fields |
|
Good job! Looks perfect for me now |
pablogarciamiranda
approved these changes
Mar 12, 2025
vaishutin
pushed a commit
to vaishutin/netbox-operator
that referenced
this pull request
Aug 17, 2025
- Add more verbose CRD documentation - Add Installation methods - Add notes on Mixed usage of Prefixes - Add FAQ Fixes netbox-community#128
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.
Fixes #128