|
| 1 | +name: Documentation Gap |
| 2 | +description: Track a documentation gap identified from API spec delta analysis. |
| 3 | +title: "Doc gap [SEVERITY]: [OPERATION_ID] — [PRODUCT] [VERSION]" |
| 4 | +labels: |
| 5 | + - source:manual |
| 6 | +body: |
| 7 | + - type: markdown |
| 8 | + attributes: |
| 9 | + value: | |
| 10 | + ## About this template |
| 11 | +
|
| 12 | + Use this template to file documentation gaps identified through API spec analysis, |
| 13 | + user feedback, or manual review. |
| 14 | +
|
| 15 | +
|
| 16 | + - type: dropdown |
| 17 | + id: severity |
| 18 | + attributes: |
| 19 | + label: Severity |
| 20 | + description: How urgently does this gap need to be addressed? |
| 21 | + options: |
| 22 | + - "🔴 Critical — write/query path affecting all users" |
| 23 | + - "🟠 High — core workflow, affects many users" |
| 24 | + - "🟡 Medium — common feature, affects some users" |
| 25 | + - "🔵 Low — edge case or rarely-used feature" |
| 26 | + validations: |
| 27 | + required: true |
| 28 | + |
| 29 | + - type: dropdown |
| 30 | + id: edition_scope |
| 31 | + attributes: |
| 32 | + label: Edition scope |
| 33 | + description: Which InfluxDB 3 editions does this gap affect? |
| 34 | + options: |
| 35 | + - Both Core and Enterprise |
| 36 | + - Core only |
| 37 | + - Enterprise only |
| 38 | + validations: |
| 39 | + required: true |
| 40 | + |
| 41 | + - type: dropdown |
| 42 | + id: change_type |
| 43 | + attributes: |
| 44 | + label: Change type |
| 45 | + description: What kind of change created this gap? |
| 46 | + options: |
| 47 | + - New endpoint (added in this release) |
| 48 | + - Modified endpoint (behavior changed in this release) |
| 49 | + - Removed endpoint (doc page references a deleted endpoint) |
| 50 | + - Existing gap (endpoint has been undocumented across releases) |
| 51 | + validations: |
| 52 | + required: true |
| 53 | + |
| 54 | + - type: input |
| 55 | + id: operation_id |
| 56 | + attributes: |
| 57 | + label: Operation ID |
| 58 | + description: The OpenAPI operationId for the affected endpoint. |
| 59 | + placeholder: "e.g. PostConfigureDatabase" |
| 60 | + validations: |
| 61 | + required: true |
| 62 | + |
| 63 | + - type: input |
| 64 | + id: api_path |
| 65 | + attributes: |
| 66 | + label: API path and method |
| 67 | + description: The HTTP method and path for the endpoint. |
| 68 | + placeholder: "e.g. POST /api/v3/configure/database" |
| 69 | + validations: |
| 70 | + required: true |
| 71 | + |
| 72 | + - type: input |
| 73 | + id: release_version |
| 74 | + attributes: |
| 75 | + label: Release version |
| 76 | + description: The InfluxDB 3 release version where this gap was identified. |
| 77 | + placeholder: "e.g. v3.9.0" |
| 78 | + validations: |
| 79 | + required: true |
| 80 | + |
| 81 | + - type: textarea |
| 82 | + id: spec_claim |
| 83 | + attributes: |
| 84 | + label: Spec claim |
| 85 | + description: | |
| 86 | + What does the OpenAPI spec say about this endpoint? |
| 87 | + Copy the relevant summary/description from the spec, or paste a link to the spec operation. |
| 88 | + placeholder: | |
| 89 | + From the spec: |
| 90 | + > Creates a new database with the specified name and optional retention period. |
| 91 | + > Parameters: db (required), retention_period (optional) |
| 92 | + validations: |
| 93 | + required: true |
| 94 | + |
| 95 | + - type: textarea |
| 96 | + id: existing_coverage |
| 97 | + attributes: |
| 98 | + label: Existing doc coverage |
| 99 | + description: | |
| 100 | + Links to any existing documentation pages that partially cover this endpoint. |
| 101 | + Leave blank if no existing coverage. |
| 102 | + placeholder: | |
| 103 | + - /influxdb3/core/admin/databases/create/ (mentions endpoint but lacks parameter docs) |
| 104 | +
|
| 105 | + - type: textarea |
| 106 | + id: suggested_location |
| 107 | + attributes: |
| 108 | + label: Suggested documentation location |
| 109 | + description: | |
| 110 | + Where should the documentation for this endpoint live? |
| 111 | + For shared Core/Enterprise content, use the shared content path. |
| 112 | + placeholder: | |
| 113 | + - content/shared/influxdb3-admin/databases/create.md (existing shared page to update) |
| 114 | + - content/influxdb3/core/admin/new-feature/ (new page needed) |
| 115 | +
|
| 116 | + - type: textarea |
| 117 | + id: engineering_verification |
| 118 | + attributes: |
| 119 | + label: Engineering verification ask |
| 120 | + description: | |
| 121 | + What do you need engineering to confirm before writing documentation? |
| 122 | + Pre-populated with standard questions — edit as needed. |
| 123 | + value: | |
| 124 | + Please confirm before documentation is written: |
| 125 | +
|
| 126 | + - [ ] Is this endpoint intended for public use in the identified release version? |
| 127 | + - [ ] Does this endpoint replace or extend an existing endpoint? If so, which one? |
| 128 | + - [ ] What are the primary use cases for end users? |
| 129 | + - [ ] Are there any known limitations, gotchas, or required prerequisites? |
| 130 | + - [ ] Is the behavior identical across Core and Enterprise, or are there edition-specific differences? |
| 131 | + validations: |
| 132 | + required: true |
| 133 | + |
| 134 | + - type: checkboxes |
| 135 | + id: definition_of_done |
| 136 | + attributes: |
| 137 | + label: Definition of done |
| 138 | + description: Check off each item as it is completed. All items must be checked before closing this issue. |
| 139 | + options: |
| 140 | + - label: Engineering confirmed the endpoint is public and stable in the identified release |
| 141 | + required: false |
| 142 | + - label: Doc page created or updated at the suggested location |
| 143 | + required: false |
| 144 | + - label: API reference entry updated (description, parameters, example request/response) |
| 145 | + required: false |
| 146 | + - label: Related guides updated if endpoint behavior changed |
| 147 | + required: false |
| 148 | + - label: Tested against the release binary (not just the spec) |
| 149 | + required: false |
| 150 | + |
| 151 | + - type: checkboxes |
| 152 | + id: edition_done |
| 153 | + attributes: |
| 154 | + label: Edition checklist |
| 155 | + description: Complete the applicable items for the affected editions. |
| 156 | + options: |
| 157 | + - label: Core behavior documented |
| 158 | + required: false |
| 159 | + - label: Enterprise-specific behavior documented (if any differences from Core) |
| 160 | + required: false |
| 161 | + - label: Superset relationship noted where applicable (Enterprise includes all Core changes) |
| 162 | + required: false |
0 commit comments