Skip to content

Fix typo in userguide java plugin config image#6011

Merged
lacasseio merged 1 commit intogradle:masterfrom
mrmeszaros:master
Jul 18, 2018
Merged

Fix typo in userguide java plugin config image#6011
lacasseio merged 1 commit intogradle:masterfrom
mrmeszaros:master

Conversation

@mrmeszaros
Copy link
Copy Markdown
Contributor

@mrmeszaros mrmeszaros commented Jul 18, 2018

Context

The dot file had a typo - a missing t in testImplementation, that created an extra node on the diagram, and caused confusion.
This has been documented in the issue #5681.

Contributor Checklist

  • Review Contribution Guidelines
  • Make sure that all commits are signed off to indicate that you agree to the terms of Developer Certificate of Origin.
  • Check "Allow edit from maintainers" option in pull request so that additional changes can be pushed by Gradle team
  • Provide integration tests (under <subproject>/src/integTest) to verify changes from a user perspective
  • Provide unit tests (under <subproject>/src/test) to verify logic
  • Update User Guide, DSL Reference, and Javadoc for public-facing changes
  • Ensure that tests pass locally: ./gradlew <changed-subproject>:check

Gradle Core Team Checklist

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation
  • Recognize contributor in release notes

@mrmeszaros
Fix typo in userguide java plugin config image
401d4a5 
The dot file had a typo - a missing `t` in `testImplementation`, that created
an extra node on the diagram, and caused confusion.

Issue: gradle#5681

Signed-off-by: Mészáros Máté Róbert <[email protected]>
@lacasseio lacasseio merged commit 401d4a5 into gradle:master Jul 18, 2018
@lacasseio
Copy link
Copy Markdown
Contributor

lacasseio commented Jul 18, 2018

I manually merged this as the png wasn't regenerated. Could be nice to get those generated as part of the user guide generation. @eriwen what do you think? I don't think it's really important but avoid debugging why the image wasn't updated.

@lacasseio lacasseio self-assigned this Jul 18, 2018
@mrmeszaros
Copy link
Copy Markdown
Contributor Author

mrmeszaros commented Jul 18, 2018

@lacasseio good catch - did not notice, that the generated images are part of the repository (did a sparse checkout).

I think it can be fixed with:

# in gradle repo
pushd subprojects/docs/src/docs/userguide/img/
dot -Tpng javaPluginConfigurations.dot > javaPluginConfigurations.png
popd

I see You have merged this - shall I create another PR for the binary image?

@lacasseio
Copy link
Copy Markdown
Contributor

lacasseio commented Jul 18, 2018

@mrmeszaros Don't worry about it. I generated the image file. It should all be good with the latest master and the next nightly.

@eriwen
Copy link
Copy Markdown
Contributor

eriwen commented Jul 18, 2018

@lacasseio I'm not opposed to generating these images in the docs pipeline. Would you want to submit a PR for that? Or at least file an issue in the appropriate place.

@lacasseio lacasseio mentioned this pull request Jul 19, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@lacasseio lacasseio

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mrmeszaros @lacasseio @eriwen