Add info on custom field usage to Custom Links #4653

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

Originally created by @mmahacek on GitHub (Mar 12, 2021).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Addition

Area

[ ] Installation instructions
[ ] Configuration parameters
[ ] Functionality/features
[ ] REST API
[ ] Administration/development
[X] Other

Proposed Changes

Include an additional note in the Custom Links section to indicate the notation for using custom fields.
{{ obj.cf.FieldName }}

Originally created by @mmahacek on GitHub (Mar 12, 2021). Originally assigned to: @jeremystretch on GitHub. ### Change Type Addition ### Area [ ] Installation instructions [ ] Configuration parameters [ ] Functionality/features [ ] REST API [ ] Administration/development [X] Other ### Proposed Changes Include an additional note in the Custom Links section to indicate the notation for using custom fields. `{{ obj.cf.FieldName }}`
adam added the status: acceptedtype: documentation labels 2025-12-29 19:19:10 +01:00
adam closed this issue 2025-12-29 19:19:10 +01:00
Author
Owner

@jeremystretch commented on GitHub (Mar 17, 2021):

This is already documented under the custom fields documentation. It works the same everywhere; there's nothing special about referencing it from within a custom link. Let's avoid introducing redundant documentation, as it presents an additional maintenance burden.

@jeremystretch commented on GitHub (Mar 17, 2021): This is already documented under the custom fields documentation. It works the same everywhere; there's nothing special about referencing it from within a custom link. Let's avoid introducing redundant documentation, as it presents an additional maintenance burden.
Author
Owner

@mmahacek commented on GitHub (Mar 17, 2021):

While I do agree that the Custom Fields documentation is a better place for this, I don't see anything on that documentation page in regards to using custom fields in jinja templates. After a bit of digging, the only place I could find a reference to this was hidden on the Export Templates page.

@mmahacek commented on GitHub (Mar 17, 2021): While I do agree that the Custom Fields documentation is a better place for this, I don't see anything on that documentation page in regards to using custom fields in jinja templates. After a bit of digging, the only place I could find a reference to this was hidden on the Export Templates page.
Author
Owner

@jeremystretch commented on GitHub (Mar 17, 2021):

My mistake; I could have sworn we added that a while ago. Still, it needs to be documented on the custom fields page, not under custom links.

@jeremystretch commented on GitHub (Mar 17, 2021): My mistake; I could have sworn we added that a while ago. Still, it needs to be documented on the custom fields page, not under custom links.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4653