Document the value behind "Default" for the Custom Link "Button Class" #9418

Closed
opened 2025-12-29 20:49:33 +01:00 by adam · 3 comments
Owner

Originally created by @maddin8 on GitHub (Apr 2, 2024).

Originally assigned to: @arthanson on GitHub.

Change Type

Addition

Area

Customization

Proposed Changes

I would like to propose that aside from the possible non-default values for "Button Class"/"button_class" of Custom Links, documentation is updated to include the information that the value displayed as "Default" in the Netbox UI is actually called "outline-dark". "Default" is as well included in CSV exports of Custom Links from already populated instances, which makes it harder for non-experienced users to determine what value to provide when mass-importing Custom Links with a button_class of "Default"(/"outline-dark").

I originally raised this in #15596 which hopefully provides enough reason why I think this should be included in the documentation.

Originally created by @maddin8 on GitHub (Apr 2, 2024). Originally assigned to: @arthanson on GitHub. ### Change Type Addition ### Area Customization ### Proposed Changes I would like to propose that aside from the possible non-default values for "Button Class"/"button_class" of Custom Links, documentation is updated to include the information that the value displayed as "Default" in the Netbox UI is actually called "outline-dark". "Default" is as well included in CSV exports of Custom Links from already populated instances, which makes it harder for non-experienced users to determine what value to provide when mass-importing Custom Links with a button_class of "Default"(/"outline-dark"). I originally raised this in #15596 which hopefully provides enough reason why I think this should be included in the documentation.
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 20:49:34 +01:00
adam closed this issue 2025-12-29 20:49:34 +01:00
Author
Owner

@maddin8 commented on GitHub (Apr 2, 2024):

Updated formatting of the table in the second commit.

@maddin8 commented on GitHub (Apr 2, 2024): Updated formatting of the table in the second commit.
Author
Owner

@jeremystretch commented on GitHub (Apr 3, 2024):

It would not be appropriate to duplicate all these entries in the written documentation. Instead, the field definition under the CSV import form should include a help button which displays the available choices, as exists for similar fields. (button_class should be defined on the form as a CSVChoiceField.)

@maddin8 do you want to try this?

@jeremystretch commented on GitHub (Apr 3, 2024): It would not be appropriate to duplicate all these entries in the written documentation. Instead, the field definition under the CSV import form should include a help button which displays the available choices, as exists for similar fields. (`button_class` should be defined on the form as a CSVChoiceField.) @maddin8 do you want to try this?
Author
Owner

@jeremystretch commented on GitHub (Apr 3, 2024):

Reclassified this as a bug, as the import form field is not of the correct type.

@jeremystretch commented on GitHub (Apr 3, 2024): Reclassified this as a bug, as the import form field is not of the correct type.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9418