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

Recipe pages with placeholders #327

Merged
merged 6 commits into from
Nov 29, 2024
Merged

Conversation

timtebeek
Copy link
Contributor

What's changed?

Swap out explicit versions for placeholders.

What's your motivation?

Stop updating these pages with every new release

Any additional context

@timtebeek timtebeek added the documentation Improvements or additions to documentation label Nov 28, 2024
@timtebeek timtebeek self-assigned this Nov 28, 2024
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor

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.

Copy link
Contributor

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 timtebeek marked this pull request as ready for review November 29, 2024 09:55
@timtebeek timtebeek merged commit 16286ad into master Nov 29, 2024
6 of 7 checks passed
@timtebeek timtebeek deleted the recipe-pages-with-placeholders branch November 29, 2024 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant