openrewrite / rewrite-gradle-plugin

OpenRewrite's Gradle plugin.
Apache License 2.0
64 stars 40 forks source link

Investigate automating docs #215

Open mike-solomon opened 1 year ago

mike-solomon commented 1 year ago

Right now, we rely on manually updating the Gradle plugin docs. Theoretically, we already get some docs automated by virtue of publishing our plugin. We should look into that further and expand the page to include more information about the available goals and options.

Related Maven issue

Related internal Slack thread

Suggested by: @timtebeek

mike-solomon commented 1 year ago

I'm not actually seeing any easy way to automate this - but I also am unsure whether it's worth the time to do this. Anyone using Gradle can just run the command ./gradlew tasks to get documentation about all of the tasks in the plugin. That is probably much easier than going to a site -- and is easier to keep up to date.