Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
maddin8 opened this issue Apr 1, 2024 · 3 comments · Fixed by #15606
Closed

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

maddin8 opened this issue Apr 1, 2024 · 3 comments · Fixed by #15606
Assignees
Labels
severity: low Does not significantly disrupt application functionality, or a workaround is available status: accepted This issue has been accepted for implementation type: bug A confirmed report of unexpected behavior in the application

Comments

@maddin8
Copy link

maddin8 commented Apr 1, 2024

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.

@maddin8 maddin8 added status: needs triage This issue is awaiting triage by a maintainer type: documentation A change or addition to the documentation labels Apr 1, 2024
@maddin8
Copy link
Author

maddin8 commented Apr 2, 2024

Updated formatting of the table in the second commit.

@jeremystretch
Copy link
Member

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 jeremystretch added type: bug A confirmed report of unexpected behavior in the application status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation severity: low Does not significantly disrupt application functionality, or a workaround is available and removed type: documentation A change or addition to the documentation status: needs triage This issue is awaiting triage by a maintainer labels Apr 3, 2024
@jeremystretch
Copy link
Member

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
severity: low Does not significantly disrupt application functionality, or a workaround is available status: accepted This issue has been accepted for implementation type: bug A confirmed report of unexpected behavior in the application
Projects
None yet
3 participants