openrewrite / rewrite-docs

Stores the markdown documents used to generate docs.openrewrite.org
https://docs.openrewrite.org
Apache License 2.0
41 stars 52 forks source link

Recipe pages with placeholders #327

Closed timtebeek closed 4 days ago

timtebeek commented 4 days ago

What's changed?

Swap out explicit versions for placeholders.

What's your motivation?

Stop updating these pages with every new release

Any additional context

github-actions[bot] commented 4 days ago

While we appreciate that you're attempting to improve the docs, please be aware that all files in the /docs/recipes directory are auto-generated by the markdown-generator.

Please make changes to the recipes themselves rather than to these files. When the next release happens, these files will be updated accordingly.

timtebeek commented 4 days ago

There appears to be a rendering issue image

ERROR
VERSION_REWRITE_RECIPE_BOM is not defined
ReferenceError: VERSION_REWRITE_RECIPE_BOM is not defined
    at _createMdxContent (eval at ./docs/reference/latest-versions-of-every-openrewrite-module.md (http://localhost:3000/content---reference-latest-versions-of-every-openrewrite-modulef-69-55e.js:4:1), <anonymous>:90:19)
    at MDXContent (eval at ./docs/reference/latest-versions-of-every-openrewrite-module.md (http://localhost:3000/content---reference-latest-versions-of-every-openrewrite-modulef-69-55e.js:4:1), <anonymous>:890:8)
    at renderWithHooks (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:15486:18)
    at mountIndeterminateComponent (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:20098:13)
    at beginWork (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:21621:16)
    at HTMLUnknownElement.callCallback (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:4164:14)
    at Object.invokeGuardedCallbackDev (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:4213:16)
    at invokeGuardedCallback (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:4277:31)
    at beginWork$1 (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:27485:7)
    at performUnitOfWork (eval at ./node_modules/react-dom/cjs/react-dom.development.js (http://localhost:3000/main.js:265:1), <anonymous>:26594:12)
timtebeek commented 4 days ago

Turns out that for now we only support those placeholders in code elements, I think; Outside of code elements it breaks. We'll have to ask for input after the holidays in the US.

github-actions[bot] commented 4 days ago

While we appreciate that you're attempting to improve the docs, please be aware that all files in the /docs/recipes directory are auto-generated by the markdown-generator.

Please make changes to the recipes themselves rather than to these files. When the next release happens, these files will be updated accordingly.

github-actions[bot] commented 4 days ago

While we appreciate that you're attempting to improve the docs, please be aware that all files in the /docs/recipes directory are auto-generated by the markdown-generator.

Please make changes to the recipes themselves rather than to these files. When the next release happens, these files will be updated accordingly.

github-actions[bot] commented 4 days ago

While we appreciate that you're attempting to improve the docs, please be aware that all files in the /docs/recipes directory are auto-generated by the markdown-generator.

Please make changes to the recipes themselves rather than to these files. When the next release happens, these files will be updated accordingly.