Skip to content
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

Investigate automating Gradle plugin documentation #215

Open
mike-solomon opened this issue Jul 18, 2023 · 1 comment
Open

Investigate automating Gradle plugin documentation #215

mike-solomon opened this issue Jul 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mike-solomon
Copy link
Contributor

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 mike-solomon added the enhancement New feature or request label Jul 18, 2023
@mike-solomon mike-solomon added the documentation Improvements or additions to documentation label Jul 18, 2023
@timtebeek timtebeek moved this to Backlog in OpenRewrite Jul 18, 2023
@timtebeek timtebeek removed the status in OpenRewrite Jul 18, 2023
@timtebeek timtebeek moved this to Backlog in OpenRewrite Jul 18, 2023
@mike-solomon
Copy link
Contributor Author

mike-solomon commented Jul 27, 2023

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.

@timtebeek timtebeek changed the title Investigate automating docs Investigate automating Gradle plugin documentation Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant