Convert documentation template to a structured issue form (bug or missing content) - #1950
Merged
Conversation
Replaces documentation-bug.md with documentation-bug.yml so fields are actually enforced at submission rather than freeform prose. Adds a required Rundeck Version field - documentation issues are often version-specific (a section can be accurate for one release and wrong for another), and the old template had no way to capture that at all. Kept the existing Describe the bug / Source page fields, now both required as well.
Renamed documentation-bug.yml -> documentation-issue.yml and adjusted scope: reports weren't always about something being wrong on an existing page - sometimes a feature just has no documentation at all and there's no page to point to. - Renamed to 'Documentation issue', description now covers both incorrect/outdated content and requests for documentation that doesn't exist yet - 'Describe the bug' -> 'Describe the issue', wording updated to prompt for either case - 'Source page' is now optional rather than required, since it doesn't apply when nothing exists yet to link to - Rundeck Version stays required - still relevant for missing-docs requests too (e.g. a feature that shipped without any docs)
fdevans
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the repository’s “documentation bug” GitHub issue template by replacing the old freeform Markdown template with a structured GitHub Issue Form, ensuring key fields are required at submission time (including the newly added Rundeck version field).
Changes:
- Added a new Issue Form template (
documentation-bug.yml) with required inputs for Rundeck Version, bug description, and source page. - Removed the legacy freeform Markdown issue template (
documentation-bug.md).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/documentation-bug.yml |
Introduces a structured Issue Form with required fields to capture version-specific documentation issues consistently. |
.github/ISSUE_TEMPLATE/documentation-bug.md |
Removes the old freeform template now superseded by the Issue Form. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Replaces the freeform
documentation-bug.mdtemplate with a GitHub Issue Form (documentation-issue.yml), and broadens its scope beyond "bug" — reports aren't always about something being wrong on an existing page; sometimes a feature just has no documentation at all, with no page to point to.Changes
documentation-bug.yml→documentation-issue.yml("Documentation issue", not "Documentation bug")Testing
Validated against GitHub's official issue-form JSON schema.