Improve Documentation For Default Values #11104

Closed
opened 2025-12-29 21:40:23 +01:00 by adam · 8 comments
Owner

Originally created by @mr1716 on GitHub (May 1, 2025).

Originally assigned to: @mr1716 on GitHub.

Change Type

Cleanup (formatting, typos, etc.)

Area

Configuration

Proposed Changes

Realized that there are a few settings that I missed last time with the change. Therefore, will correct that this time

Originally created by @mr1716 on GitHub (May 1, 2025). Originally assigned to: @mr1716 on GitHub. ### Change Type Cleanup (formatting, typos, etc.) ### Area Configuration ### Proposed Changes Realized that there are a few settings that I missed last time with the change. Therefore, will correct that this time
adam added the status: acceptedtype: documentation labels 2025-12-29 21:40:23 +01:00
adam closed this issue 2025-12-29 21:40:23 +01:00
Author
Owner

@bctiemann commented on GitHub (May 1, 2025):

Could you please indicate some examples of what needs to be fixed?

@bctiemann commented on GitHub (May 1, 2025): Could you please indicate some examples of what needs to be fixed?
Author
Owner

@mr1716 commented on GitHub (May 1, 2025):

@bctiemann thanks for following up. Here are 2 examples. There’s also 1 more field

Image

@mr1716 commented on GitHub (May 1, 2025): @bctiemann thanks for following up. Here are 2 examples. There’s also 1 more field ![Image](https://github.com/user-attachments/assets/e25f7811-fffa-40a5-91cf-db6c3eec6fe3)
Author
Owner

@bctiemann commented on GitHub (May 1, 2025):

OK -- note that in NetBox 4.3, we now support the STORAGES structure rather than the legacy STORAGE_BACKEND and STORAGE_CONFIG, so these documentation examples might be out of date. We've just release v4.3; could you check it out and see if this issue is still relevant?

Thanks!

@bctiemann commented on GitHub (May 1, 2025): OK -- note that in NetBox 4.3, we now support the `STORAGES` structure rather than the legacy `STORAGE_BACKEND` and `STORAGE_CONFIG`, so these documentation examples might be out of date. We've just release v4.3; could you check it out and see if this issue is still relevant? Thanks!
Author
Owner

@mr1716 commented on GitHub (May 1, 2025):

@bctiemann that specific thing was fixed but there are other items that still need to be resolved

Image

@mr1716 commented on GitHub (May 1, 2025): @bctiemann that specific thing was fixed but there are other items that still need to be resolved ![Image](https://github.com/user-attachments/assets/c79e4189-f3bd-4e96-a880-791ce0cea6af)
Author
Owner

@mr1716 commented on GitHub (May 1, 2025):

@bctiemann here’s another. I can handle this later today

Image

@mr1716 commented on GitHub (May 1, 2025): @bctiemann here’s another. I can handle this later today ![Image](https://github.com/user-attachments/assets/ffb95381-0b88-4103-9b1c-3e9ffa40039b)
Author
Owner

@bctiemann commented on GitHub (May 1, 2025):

I'm confused — what is the issue with these docs? Are there typos? Or is the information incorrect? I'm not seeing what needs to be fixed.

If you're referring to the !!! note and !!! warning blocks, those render in the docs website via Markdown:

https://netbox.readthedocs.io/en/stable/configuration/security/#login_form_hidden

Image
@bctiemann commented on GitHub (May 1, 2025): I'm confused — what is the issue with these docs? Are there typos? Or is the information incorrect? I'm not seeing what needs to be fixed. If you're referring to the `!!! note` and `!!! warning` blocks, those render in the docs website via Markdown: https://netbox.readthedocs.io/en/stable/configuration/security/#login_form_hidden <img width="760" alt="Image" src="https://github.com/user-attachments/assets/35e7ea1b-b9b4-4d63-8371-9b57bcf5115f" />
Author
Owner

@mr1716 commented on GitHub (May 1, 2025):

@bctiemann sorry if I wasnt clear but will be now. Every other item has a standard default value that follows the photo below, but these dont.

Image

@mr1716 commented on GitHub (May 1, 2025): @bctiemann sorry if I wasnt clear but will be now. Every other item has a standard default value that follows the photo below, but these dont. ![Image](https://github.com/user-attachments/assets/4aef1d2e-a0b5-420e-b233-1eaf2b0f8593)
Author
Owner

@bctiemann commented on GitHub (May 1, 2025):

Ah! Okay, thanks, that makes sense.

@bctiemann commented on GitHub (May 1, 2025): Ah! Okay, thanks, that makes sense.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11104