Author: hartmannathan Date: Thu Jan 30 22:06:08 2025 New Revision: 1923465 URL: http://svn.apache.org/viewvc?rev=1923465&view=rev Log: In site/staging: Try to be more helpful to bug reporters
Subversion's "Reporting Issues" page was directing bug reporters to use the Self Serve portal to request their own Jira account. However, it also implored them to discuss their potential bug reports at the mailing list before adding them to the issue tracker. Unfortunately, community members sometimes didn't notice that and proceeded to request a Jira account, only to have us decline their request and direct them back to the mailing list. This had to be frustrating for everyone. I hope the following changes improve clarity and result in a better experience: * reporting-issues.html (): Remove everything until "Handy Dandy Issue Tracker Queries" (#report-bug, #request-feature): New subsections. (Link to the Jira self-serve portal): Move from this user-facing page... * docs/community-guide/issues.part.html: (#bugs-where-issue-tracker): ...to this new subsection in HACKING, the rationale being that if we'd like to extend a Jira account to certain community members, we can always direct them here. (#bugs-where): Re-route the "[o]nce it's confirmed as a bug" link to this new subsection. Proposed by me at dev@ thread "Propose changes to the Reporting Issues page" started 28 January 2025, archived: https://lists.apache.org/thread/0dcdlb6tk9o497xjskktj2vo83m1pbwb The copy-and-paste email template in reporting-issues.html#report-bug was Suggested by: cmpilato Modified: subversion/site/staging/docs/community-guide/issues.part.html subversion/site/staging/reporting-issues.html Modified: subversion/site/staging/docs/community-guide/issues.part.html URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/community-guide/issues.part.html?rev=1923465&r1=1923464&r2=1923465&view=diff ============================================================================== --- subversion/site/staging/docs/community-guide/issues.part.html (original) +++ subversion/site/staging/docs/community-guide/issues.part.html Thu Jan 30 22:06:08 2025 @@ -162,7 +162,7 @@ make the bug much more likely to get fix <a href="mailto:[email protected]"; >[email protected]</a>. Once it's confirmed as a bug, someone, possibly you, can enter it - into the <a href="/reporting-issues.html" + into the <a href="#bugs-where-issue-tracker" >issue tracker</a>. (Or if you're pretty sure about the bug, go ahead and post directly to our development list, <a href="mailto:[email protected]"; @@ -202,6 +202,25 @@ make the bug much more likely to get fix </ul> +<div class="h3" id="bugs-where-issue-tracker"> +<h3>Issue Tracker + <a class="sectionlink" href="<!--#echo var="GUIDE_ISSUES_PAGE" -->#bugs-where-issue-tracker" + title="Link to this section">¶</a> +</h3> + +<p>You need to have an account to create issues. If you are already + a committer, use your @apache.org account to sign in. Otherwise, + you can apply for an account using the <a + href="https://selfserve.apache.org/jira-account.html"; + >Self-serve Portal</a>. Please add a reference to the mailing + list discussion in the "Tell us a little [...]" input field to + speed up the review process.</p> + +<p>See also, the <a href="/reporting-issues.html">Reporting Issues</a> + page for general audiences.</p> + +</div> <!-- bugs-where-issue-tracker --> + </div> <!-- bugs-where --> Modified: subversion/site/staging/reporting-issues.html URL: http://svn.apache.org/viewvc/subversion/site/staging/reporting-issues.html?rev=1923465&r1=1923464&r2=1923465&view=diff ============================================================================== --- subversion/site/staging/reporting-issues.html (original) +++ subversion/site/staging/reporting-issues.html Thu Jan 30 22:06:08 2025 @@ -21,43 +21,86 @@ <h1>Apache Subversion Issues</h1> -<div class="bigpoint"> +<div class="h2" id="report-bug"> +<h2>Report A Bug + <a class="sectionlink" href="#report-bug" + title="Link to this section">¶</a> +</h2> + +<p>If you believe you have encountered a bug in Subversion, please + write to the Subversion Users mailing list + (<a href="mailto:[email protected]"; + >[email protected]</a>) and provide as much information + as practical. You can copy-and-paste the following email template + and fill in the relevant items:</p> + +<pre> +* What steps led to the issue: + +* The expected outcome: + +* The actual outcome: + +* Subversion client version: + +* Subversion server version: + +* If you built Subversion yourself, compiler and configuration options used: + +* Any customizations which could be relevant: + +* Your operating system: -<p>Please do not file new issues before validating your complaint via - a well-formed bug report sent to:</p> +* Any similar bugs already in the issue tracker: + +* Any other details you believe are relevant: + +* Reproduction script: +</pre> + +<p>The more detail you can provide, the more likely it is that someone + can help.</p> + +<p>For the version or revision of your Subversion client, you can copy + and paste the output of <tt>svn --version</tt> or + <tt>svn --version --verbose</tt>.</p> + +<p>See <a href="https://subversion.apache.org/mailing-lists.html"; + >Mailing Lists</a> for how to subscribe, unsubscribe, and send + email to the users@ mailing list. + +<p>For more on how the Subversion developers track and handle bug + reports, see the <a href="docs/community-guide/issues.html" + >"Bugs / Issues" section</a> of the <a href="docs/community-guide/" + >Subversion Community Guide</a>.</p> + +</div> <!-- #report-bug --> + +<div class="h2" id="request-feature"> +<h2>Request A New Feature + <a class="sectionlink" href="#request-feature" + title="Link to this section">¶</a> +</h2> -<p><a href="mailto:[email protected]"; - >[email protected]</a></p> +<p>Subversion is an open source project developed and supported by + volunteers. This means you can contribute to Subversion! It also + means that any features you request have the highest chance of + becoming reality if you are willing to do the development + effort.</p> + +<p>We strongly recommend to discuss any new feature ideas at the + Subversion Developers mailing list + (<a href="mailto:[email protected]"; + >[email protected]</a>).</p> + +<p>See <a href="https://subversion.apache.org/mailing-lists.html"; + >Mailing Lists</a> for how to subscribe, unsubscribe, and send + email to the dev@ mailing list. -<p>Unvalidated issues will be unceremoniously closed. Trust us - — we have <a href="docs/community-guide/issues.html" >good - reasons</a> for this.</p> - -</div> <!-- .bigpoint --> - -<p>Chances are good that if you're on this page, you've come either to - complain about Subversion, or you've come to check on a previous - complaint about Subversion. Hey, we understand that. And for what - it's worth, Subversion is the amazing software that it is largely - because of the constructive criticism we've received about it over - the years. Having said that, we <strong>strongly</strong> - recommend that if you've not done so already, you read the - <a href="docs/community-guide/issues.html" >"Bugs / Issues" section</a> - of the <a href="docs/community-guide/" >Subversion Community - Guide</a>. Not only will you learn how to increase the quality of - your own complaints and requests, but in doing so, you'll increase - the likelihood that we'll recognize them as constructive.</p> - -<p>You need to have an account to create issues. If you are already - a committer, use your @apache.org account to sign in. Otherwise, - you can apply for an account using the <a - href="https://selfserve.apache.org/jira-account.html"; - >Self-serve Portal</a>. Please add a reference to the mailing - list discussion in the "Tell us a little [...]" input field to - speed up the review process.</p> +</div> <!-- #request-feature --> <div class="h2" id="queries"> -<h2>Handy Dandy Issue Tracker Queries +<h2>Search Existing Issues <a class="sectionlink" href="#queries" title="Link to this section">¶</a> </h2>
