Including examples of usage of controls beyond the observation that said controls exist #5909

Closed
opened 2025-12-29 19:34:06 +01:00 by adam · 3 comments
Owner

Originally created by @bitshiftnetau on GitHub (Jan 8, 2022).

Change Type

Addition

Area

Other

Proposed Changes

The docs are rather sparse, to say the least. This is nothing short of the most beautiful irony.

It would be helpful to include examples of usage, where controls are located, what must precede their creation, etc..

Common sense could apply here but I will give a general example:

https://netbox.readthedocs.io/en/stable/models/dcim/virtualchassis/

"To add a virtual chassis, go to X and select Y. In order to create a virtual chassis you will need to do A or B and C"

Originally created by @bitshiftnetau on GitHub (Jan 8, 2022). ### Change Type Addition ### Area Other ### Proposed Changes The docs are rather sparse, to say the least. This is nothing short of the most beautiful irony. It would be helpful to include examples of usage, where controls are located, what must precede their creation, etc.. Common sense could apply here but I will give a general example: https://netbox.readthedocs.io/en/stable/models/dcim/virtualchassis/ "To add a virtual chassis, go to X and select Y. In order to create a virtual chassis you will need to do A or B and C"
adam added the type: documentation label 2025-12-29 19:34:06 +01:00
adam closed this issue 2025-12-29 19:34:06 +01:00
Author
Owner

@bitshiftnetau commented on GitHub (Jan 9, 2022):

Happy to do the work, though I am very new to netbox and don't have some of these answers (hence the request 😅). Will need some guidance.

@bitshiftnetau commented on GitHub (Jan 9, 2022): Happy to do the work, though I am very new to netbox and don't have some of these answers (hence the request 😅). Will need some guidance.
Author
Owner

@DanSheps commented on GitHub (Jan 9, 2022):

Issues are not a place to have answers answered. There is slack and GitHub discussions for that.

@DanSheps commented on GitHub (Jan 9, 2022): Issues are not a place to have answers answered. There is slack and GitHub discussions for that.
Author
Owner

@bitshiftnetau commented on GitHub (Jan 9, 2022):

Nah that's alright. Think I might just use something else. Thanks anyway!

@bitshiftnetau commented on GitHub (Jan 9, 2022): Nah that's alright. Think I might just use something else. Thanks anyway!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5909