feat(issue-template): add documentation gap ticket form#7137
Merged
jstirnaman merged 4 commits intomasterfrom Apr 24, 2026
Merged
feat(issue-template): add documentation gap ticket form#7137jstirnaman merged 4 commits intomasterfrom
jstirnaman merged 4 commits intomasterfrom
Conversation
Salvaged from closed PR #7058. Provides a structured form for manually filing documentation gaps identified through API spec analysis, user feedback, or manual review. Severity, edition scope, change type, operation ID, spec claim, suggested location, engineering verification ask, and definition-of-done checklist. Labels aligned with existing source:* taxonomy (source:manual). The release-pipeline auto-file path referenced in the template will be wired up in a follow-up that invokes docs-tooling gap-detection from .github/workflows/influxdb3-release.yml.
jstirnaman
requested review from
Copilot and
sanderson
and removed request for
a team and
sanderson
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new GitHub Issue Forms template to standardize how contributors file manual “documentation gap” tickets (capturing severity, edition scope, change type, spec claim, suggested doc location, and verification/DoD checklists).
Changes:
- Introduces a new issue form: Documentation Gap (
doc-gap-ticket.yml) - Applies the existing label taxonomy by tagging new issues with
source:manual
jstirnaman
commented
Apr 24, 2026
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
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.
Summary
.github/ISSUE_TEMPLATE/doc-gap-ticket.yml— structured form for manually filing documentation gaps (severity, edition scope, change type, operation ID, spec claim, suggested location, engineering verification ask, definition-of-done checklist).source:*taxonomy (source:manual) — the template's originaldocumentation/doc-gap/needs-triagelabels don't exist in this repo.Follow-ups (not in this PR)
.github/workflows/influxdb3-release.ymlto cloneinfluxdata/docs-toolingand invoke its gap-detection CLI; that workflow will auto-file issues using the docs-toolinggap-issue-bodybuilder, distinct from this manual template.Test plan
source:manualexists)