Skip to content

Add info on custom field usage to Custom Links #5965

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

Closed
mmahacek opened this issue Mar 12, 2021 · 3 comments
Closed

Add info on custom field usage to Custom Links #5965

mmahacek opened this issue Mar 12, 2021 · 3 comments
Assignees
Labels
status: accepted This issue has been accepted for implementation type: documentation A change or addition to the documentation

Comments

@mmahacek
Copy link
Contributor

mmahacek commented Mar 12, 2021

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 }}

@mmahacek mmahacek added the type: documentation A change or addition to the documentation label Mar 12, 2021
@jeremystretch
Copy link
Member

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.

@mmahacek
Copy link
Contributor Author

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.

@jeremystretch jeremystretch reopened this Mar 17, 2021
@jeremystretch
Copy link
Member

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 jeremystretch added the status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation label Mar 17, 2021
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation and removed status: needs owner This issue is tentatively accepted pending a volunteer committed to its implementation labels Mar 31, 2021
@jeremystretch jeremystretch self-assigned this Mar 31, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: documentation A change or addition to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants