[GRADLE-325] Gradle user manual needs an index Created: 20/Dec/08  Updated: 24/Jan/17  Resolved: 24/Jan/17

Status: Resolved
Project: Gradle
Affects Version/s: 0.5
Fix Version/s: None

Type: Bug
Reporter: Jon Cox Assignee: Unassigned
Resolution: Won't Fix Votes: 0


 Description   

As a new Gradle user, one of the hardest parts of getting started is to connect various terms and
default functions offered with where they're actually demonstrated & described in the user manual.

Compounding factors:

o Gradle offers quite a few features
o Forward references to concepts & functions not yet described are plentiful
o Most of the source text snippets lack comments to clarify what's going on & reinforce what's been learned so far

Even if a reorganization of the docs is in the works, an index would be a nice stopgap;
if it's autogenerated on the basis of markup in the source text, the infrastructure to create
it could be reused.

 Comments   
Comment by Benjamin Muschko [ 15/Nov/16 ]

As announced on the Gradle blog we are planning to completely migrate issues from JIRA to GitHub.

We intend to prioritize issues that are actionable and impactful while working more closely with the community. Many of our JIRA issues are inactionable or irrelevant. We would like to request your help to ensure we can appropriately prioritize JIRA issues you’ve contributed to.

Please confirm that you still advocate for your JIRA issue before December 10th, 2016 by:

  • Checking that your issues contain requisite context, impact, behaviors, and examples as described in our published guidelines.
  • Leave a comment on the JIRA issue or open a new GitHub issue confirming that the above is complete.

We look forward to collaborating with you more closely on GitHub. Thank you for your contribution to Gradle!

Comment by Benjamin Muschko [ 24/Jan/17 ]

Creating an index would be a lot of work to create and maintain. Instead we want to make the user guide more approachable by restructuring it.

Generated at Wed Jun 30 11:27:18 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.