This PR updates the documentation to reflect the use of GitHub Issues and GitHub Discussions, and marks JIRA as legacy for archival purposes only. Resolves #281. #282
Conversation
There was a problem hiding this comment.
Pull request overview
Updates Shiro website documentation to reflect GitHub Issues as the primary tracker, add GitHub Discussions for Q&A/community discussion, and demote JIRA to legacy/archival status (resolves #281).
Changes:
- Adds GitHub Discussions and GitHub Issues links to support/community-facing docs.
- Updates the issues tracking page to describe GitHub Issues usage and adds a JIRA (Legacy) section.
- Renames the mailing list entry from “Shiro Issues/JIRA List” to “Shiro Issues List”.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/site/content/support.adoc |
Adds GitHub Discussions/Issues links to the support resources list (and removes the local issues page link). |
src/site/content/mailing-lists.adoc |
Renames the issues list label to remove “JIRA”. |
src/site/content/issues.adoc |
Switches primary guidance to GitHub Issues/Discussions and adds a JIRA legacy note/link. |
src/site/content/forums.adoc |
Adds a GitHub Discussions section above mailing list archive links. |
src/site/content/community.adoc |
Splits the former generic issue tracker reference into distinct Discussions and Issues entries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Apache Shiro uses https://github.com/apache/shiro/issues[GitHub Issues] for bug reports, feature requests, and task tracking. | ||
|
|
||
| For questions, ideas, and community discussions, please use https://github.com/apache/shiro/discussions[GitHub Discussions]. |
There was a problem hiding this comment.
The page metadata still says it uses Atlassian Jira (":jbake-description: ... using Atlassian Jira issue tracking system."), but the content now points users to GitHub Issues/Discussions. Please update the jbake description (and any other metadata on this page that mentions Jira as current) so SEO/page summaries aren’t misleading.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| GitHub Issues is provided as a Shiro software development resource. | ||
| It is meant for reporting bugs, requesting features, and tracking improvements in the software itself - it is not a support portal to ask for advice or help. | ||
| For community advice and help in using Apache Shiro, please visit the link:/support.html[Support] page or use https://github.com/apache/shiro/discussions[GitHub Discussions]. |
There was a problem hiding this comment.
PR description says support.adoc was updated to add GitHub Discussions/Issues at the top of support resources, but support.adoc currently has no GitHub Discussions/Issues entries. Either update support.adoc accordingly or adjust the PR description to match the actual changes.
| :jbake-status: published | ||
| :jbake-tags: issues, bugs, jira, bug-tracking, support | ||
| :jbake-description: Report bugs, request features, and track issues for Apache Shiro using Atlassian Jira issue tracking system. | ||
| :jbake-description: Report bugs, request features, and track issues for Apache Shiro using GitHub Issues tracking system. |
There was a problem hiding this comment.
The jbake description reads "using GitHub Issues tracking system", which is grammatically awkward. Consider rephrasing to "using GitHub Issues" or "using the GitHub Issues issue-tracking system".
| :jbake-description: Report bugs, request features, and track issues for Apache Shiro using GitHub Issues tracking system. | |
| :jbake-description: Report bugs, request features, and track issues for Apache Shiro using GitHub Issues. |
| ____ | ||
|
|
||
| *NOTE:* The primary forums for Apache Shiro are the mailing lists, which can be accessed via the link:mailing-lists.html[Mailing Lists] page. This is per the Apache Software Foundation's community guidelines. | ||
|
|
||
| ____ |
There was a problem hiding this comment.
The NOTE callout is currently written as bold text inside an open block (____). In AsciiDoc, this won't render as an admonition; prefer using a proper NOTE admonition (e.g., "NOTE: ..." or a [NOTE] block) and drop the open block unless it is needed for formatting.
| * *https://github.com/apache/shiro/discussions[GitHub Discussions]* - For questions, ideas, and community discussion | ||
|
|
||
| * *https://github.com/apache/shiro/issues[GitHub Issues]* - For bug reports and feature requests |
There was a problem hiding this comment.
After adding GitHub Discussions/Issues links here, the earlier bullet in this file that says the project "use[s] Nabble" for forums is now inconsistent with the updated forums page (and the note that Nabble no longer hosts archives). Please update/remove the Nabble wording to match the current support channels.
2 participants
This PR updates the documentation to reflect the use of GitHub Issues and GitHub Discussions, and marks JIRA as legacy for archival purposes only.
Changes
Resolves #281.