docs(jira): show what belongs inside the custom fields box - #243
Open
knakul853 wants to merge 2 commits into
Open
docs(jira): show what belongs inside the custom fields box#243knakul853 wants to merge 2 commits into
knakul853 wants to merge 2 commits into
Conversation
The cloud setup step pointed at a whole nuclei config whose custom fields sit under a `custom_fields:` key, so users pasted that key into a box that supplies it for them and their fields landed one level too deep. Show the entries on their own with a warning, and correct the nuclei example to the `custom-fields` spelling the parser actually reads. Claude-Session: https://claude.ai/code/session_012yFBq5uTJ1VdtUKR32kZHQ Claude-Local-Session: claude --resume 509802c8-9204-430b-9d1d-49b8aca5b353
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
knakul853
marked this pull request as ready for review
September 10, 2026 14:53
The aurora and platform-ui fixes lift such a key, so warning that the tracker cannot read the fields would be describing a failure that no longer happens. Claude-Session: https://claude.ai/code/session_012yFBq5uTJ1VdtUKR32kZHQ Claude-Local-Session: claude --resume 509802c8-9204-430b-9d1d-49b8aca5b353
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change
The cloud setup step told users to "add any Custom field details" and linked to a whole nuclei config, where the block sits under a
custom_fields:key. The Custom Fields box supplies that key itself, so pasting from the example nests the fields one level too deep and no ticket gets them. Reopening the config redisplays the stray key, which makes the broken shape look right.connectjira.mdxshows the entries on their own, with a warning not to add acustom-fields:linerunning.mdxcorrected fromcustom_fieldsto thecustom-fieldsthe parser actually readsEvidence
custom-fieldsis the yaml tag on the tracker's options struct, so the underscore spelling in the example never parsed, in cloud or OSS.Reproduced on dev: the wrapped shape fails with
couldn't iterate on nested item; the shape now documented reaches Jira. Template variables in the new example (.Severity,.CVSSMetrics) were checked against the tracker's template context.Still open
Claude-Session: https://claude.ai/code/session_012yFBq5uTJ1VdtUKR32kZHQ
Claude-Local-Session: claude --resume 509802c8-9204-430b-9d1d-49b8aca5b353