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

Expand refaster documentation #256

Closed
mike-solomon opened this issue Jan 16, 2024 · 1 comment · Fixed by #259
Closed

Expand refaster documentation #256

mike-solomon opened this issue Jan 16, 2024 · 1 comment · Fixed by #259
Assignees
@mike-solomon
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mike-solomon
Copy link
Contributor

While we have some basic documentation explaining what a Refaster recipe is, we don't provide enough information about how to get started with them or use them in projects.

We should consider expanding our docs to provide additional context -- perhaps a getting started with refaster guide?

Relevant community Slack link where this was requested
@mike-solomon mike-solomon added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 16, 2024
@knutwannheden
Copy link
Contributor

Please reach out to Tim or me if you need some answers to Refaster questions.

@timtebeek timtebeek moved this to Backlog in OpenRewrite Jan 16, 2024
mike-solomon added a commit that referenced this issue Jan 22, 2024
@mike-solomon
Add Refaster template recipe docs
9ee111f 
Fixes: #256
@mike-solomon mike-solomon mentioned this issue Jan 22, 2024
Merged
@timtebeek timtebeek moved this from Backlog to Ready to Review in OpenRewrite Jan 22, 2024
mike-solomon added a commit that referenced this issue Jan 22, 2024
@mike-solomon @timtebeek
Add Refaster template recipe docs (#259)
277a7a1 
* Add Refaster template recipe docs

Fixes: #256

* Fix spelling warnings

* Update authoring-recipes/refaster-recipes.md

Co-authored-by: Tim te Beek <[email protected]>

* Update authoring-recipes/refaster-recipes.md

Co-authored-by: Tim te Beek <[email protected]>

* Update authoring-recipes/refaster-recipes.md

Co-authored-by: Tim te Beek <[email protected]>

---------

Co-authored-by: Mike Solomon <[email protected]>
Co-authored-by: Tim te Beek <[email protected]>
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Jan 22, 2024
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

Successfully merging a pull request may close this issue.

Add Refaster template recipe docs openrewrite/rewrite-docs
2 participants
@knutwannheden @mike-solomon