Skip to content

Commit

Permalink
Update instructions to create new version of the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
timtebeek committed Nov 27, 2024
1 parent 13e6d1f commit b18e3d5
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Note: It's possible that with old versions of Rewrite that the markdown generato
### Automated Recipe Docs

When you run this project for either a snapshot or a full release, all documentation will be updated in the
`build/docs` directory. There are three key pieces to that: the `reference` folder and the `SUMMARY_snippet.md`
`build/docs` directory. There are three key pieces to that: the `recipes` folder and the `SUMMARY_snippet.md`
and `latest-versions-of-every-openrewrite-module.md` files.

If you wish to update the [docs](https://docs.openrewrite.org/reference/recipes), you should replace [this directory](https://github.com/openrewrite/rewrite-docs/tree/master/reference/recipes)
Expand Down Expand Up @@ -89,9 +89,10 @@ Quickstart:

### Replace rewrite-docs references
```shell
rm -rf ../../rewrite-docs/reference/recipes
cp -r build/docs/reference/recipes ../../rewrite-docs/reference/
cp -r build/docs/latest-versions-of-every-openrewrite-module.md ../../rewrite-docs/reference/
rm -rf ../rewrite-docs/docs/recipes/
cp -r build/docs/recipes ../rewrite-docs/docs/recipes
cp -r build/docs/*.md ../rewrite-docs/docs/reference/
cp src/main/resources/8-*-Release.md ../rewrite-docs/docs/changelog/
```

## Known Issues
Expand Down

0 comments on commit b18e3d5

Please sign in to comment.