Skip to content

Improve links to Gradle plugin's documentation #9386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

vpavic
Copy link
Contributor

@vpavic vpavic commented Jun 1, 2017

The documentation currently links to directory listing instead of the actual Gradle plugin reference guide.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 1, 2017
@wilkinsona
Copy link
Member

That was actually intentional as I wanted people to realise that the reference documentation was available as HTML and PDF, and that there was API documentation available too.

I'm open to suggestions as how it could be done better than it currently is, but I'm not sure that just linking straight to the HTML reference documentation is the answer.

@wilkinsona wilkinsona added the status: waiting-for-feedback We need additional information before we can continue label Jun 1, 2017
@vpavic
Copy link
Contributor Author

vpavic commented Jun 1, 2017

I see - wasn't aware that it was intentional.

Well, IMO it's definitely not ideal since I constantly find myself navigating through the directory listing to reference doc (which is an additional two clicks away).

Perhaps we could replace:

A reference to Gradle plugin

With something like:

A reference to Gradle plugin (reference | API)

@wilkinsona wilkinsona closed this in 45a337b Jun 2, 2017
@wilkinsona wilkinsona changed the title Fix link to Gradle plugin reference guide Improve links to Gradle plugin's documentation Jun 2, 2017
@wilkinsona
Copy link
Member

Thanks, @vpavic. I've hopefully improved things in 45a337b.

@wilkinsona wilkinsona added this to the 2.0.0.M2 milestone Jun 2, 2017
@wilkinsona wilkinsona added priority: normal type: documentation A documentation update and removed status: waiting-for-feedback We need additional information before we can continue status: waiting-for-triage An issue we've not yet triaged labels Jun 2, 2017
@vpavic vpavic deleted the fix-docs branch June 2, 2017 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants