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.

Sign up for GitHub

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

Jump to bottom

Investigate automating docs #602

Closed
mike-solomon opened this issue Jul 18, 2023 · 2 comments
Closed

Investigate automating docs #602

mike-solomon opened this issue Jul 18, 2023 · 2 comments
Assignees
@mike-solomon
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mike-solomon
Copy link
Contributor

mike-solomon commented Jul 18, 2023 •
edited
Loading

Right now, we rely on manually updating the Maven plugin docs. Theoretically, we could use something like the maven docc plugin to automate the creation of docs for this plugin.

We could then invoke this new goal and place the HTML in some target/ directory that we could publish.

Related Gradle issue

Related internal Slack thread

Suggested by: @timtebeek
@mike-solomon mike-solomon added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 18, 2023
@mike-solomon mike-solomon mentioned this issue Jul 18, 2023
Open
@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
@timtebeek timtebeek mentioned this issue Jul 18, 2023
Merged
3 tasks
@timtebeek
Copy link
Contributor

Added a quick first attempt in #603 ; needs more work to finish that, but it's a start to take over whenever you have time.

@mike-solomon mike-solomon self-assigned this Jul 27, 2023
@mike-solomon
Copy link
Contributor Author

This has been completed (#608)

see: https://openrewrite.github.io/rewrite-maven-plugin/

@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenRewrite Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mike-solomon mike-solomon

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
OpenRewrite
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@timtebeek @mike-solomon