openrewrite / openrewrite/rewrite-docs
Make a guide for executing multiple recipes
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 55
- Forks
- 78
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 12
Description
Right now, we have a quick start guide that covers the basics for running recipes. However, it seems like it may be trying to do too much in one spot. Some people are finding it difficult to understand how to tie recipes together so that you can do a combination of things at once (such as taking things from one recipe and feeding it into another). We should consider creating a guide that explores this concept further.
Related internal slack thread: https://moderneinc.slack.com/archives/C01VADFPJQZ/p1689622318055079
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the quick start guide at the linked “Running recipes from external modules” section and the related Slack thread. Clarify how multiple recipes can be tied together, including feeding one recipe’s results into another, and consider how this material should be separated from the existing guide. Done means a focused guide that explains this workflow clearly with useful examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100