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

Add doc for types of recipes #242

Merged
merged 5 commits into from
Oct 27, 2023
Merged

Add doc for types of recipes #242

merged 5 commits into from
Oct 27, 2023

Conversation

mike-solomon
Copy link
Contributor

To help people understand what the different types are. The intention is to add a more dedicated Refaster guide after this and then link to it from this doc.

authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show resolved Hide resolved
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
authoring-recipes/types-of-recipes.md Fixed Show fixed Hide fixed
To help people understand what the different types are. The intention
is to add a more dedicated Refaster guide after this and then link to
it from this doc.
@openrewrite openrewrite deleted a comment from github-actions bot Oct 26, 2023
@mike-solomon
Copy link
Contributor Author

@timtebeek @knutwannheden I think I addressed your feedback. If you could take a look and let me know again when you have a sec, I'd appreciate it ^_^

Copy link
Contributor

@timtebeek timtebeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition to our docs, thanks!

@timtebeek timtebeek linked an issue Oct 27, 2023 that may be closed by this pull request
---
```

Another good example that demonstrates how you can use a declarative recipe to define a complex migration recipe is the [ApacheHttpClient migration recipe](https://github.com/openrewrite/rewrite-spring/blob/main/src/main/resources/META-INF/rewrite/apache-httpclient-5.yml):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps there's a good hook here to tell folks that they can compose such recipes through the recipe builder at https://app.moderne.io/recipes/builder ; that allows them to try it out, and has people explore the recipes in the platform.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea! Will add

@mike-solomon mike-solomon merged commit bb565a0 into master Oct 27, 2023
7 checks passed
@mike-solomon mike-solomon deleted the add-types branch October 27, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Document Refaster rule & recipe development
3 participants