rewrite-docs
rewrite-docs copied to clipboard
openrewrite
Stores the markdown documents used to generate docs.openrewrite.org
As of OpenRewrite 8 the JavaTemplate API changed quite a bit and also introduces the distinction of context-free and -sensitive templates. This calls for an overhaul of the documentation on...
Right now, we have a [quick start guide](https://docs.openrewrite.org/running-recipes/getting-started#step-6-running-recipes-from-external-modules) that covers the basics for running recipes. However, it seems like it may be trying to do too much in one spot....
Yaml Change Key as an example; there's [a test annotated with DocumementExample](https://github.com/openrewrite/rewrite/blob/c75ead0ed463b9df751c3d15ab3126f1d373f998/rewrite-yaml/src/test/java/org/openrewrite/yaml/ChangeKeyTest.java#L47), yet there's no example shown in the docs at https://docs.openrewrite.org/recipes/yaml/changekey
We've had [data flow analysis](https://github.com/openrewrite/rewrite/tree/main/rewrite-java/src/main/java/org/openrewrite/java/dataflow) as an incubating feature for a while now; in particular [in rewrite-java-security](https://github.com/openrewrite/rewrite-java-security/search?q=dataflow). Might be good to document or at least mention this feature in the...
I was working with someone recently who was getting started with recipe development, using a Maven project. When trying to run their `SayHello` recipe, they ran into the cryptic recipe-deserialization...
## What problem are you trying to solve? As explained on Slack, https://rewriteoss.slack.com/archives/C01AB6L98TC/p1687767750280069: We have an [artifact](https://github.com/quarkusio/quarkus-updates/tree/main/recipes) with dependency on various OpenRewrite modules, this also reference Maven and Gradle plugins...
We already have a few places where we describe how to best tune your local environment and IDE for recipe development: - https://github.com/openrewrite/rewrite/blob/main/CONTRIBUTING.md - https://docs.openrewrite.org/authoring-recipes/recipe-development-environment - https://docs.openrewrite.org/reference/building-openrewrite-from-source Yet we can...
Throughout our docs we provide many explicit versions for libraries. It's nearly impossible to ensure they're all up-to-date given GitBooks limitations. We should update the docs to use `LATEST` or...
As [suggested on Slack](https://rewriteoss.slack.com/archives/C01A843MWG5/p1719133579095089?thread_ts=1713533066.442339&cid=C01A843MWG5). > My degree is not in education nor writing, i can only speak from my personal learning curve experience in the last three weeks. The docs...
## What problem are you trying to solve? Folks might not be aware that we are able to confidently solve vulnerabilities using OpenRewrite recipes, and also bump transitive dependencies. ##...
Metadata
Owner
Metadata
Stores the markdown documents used to generate docs.openrewrite.org