-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
wrangler: document the new "redirected" configuration feature #18757
wrangler: document the new "redirected" configuration feature #18757
Conversation
|
||
::: | ||
|
||
When using a framework or a custom pre-build process, some tools need to generate a modified Wrangler configuration alongside the generated code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When using a framework or a custom pre-build process, some tools need to generate a modified Wrangler configuration alongside the generated code. | |
When using a framework or a custom pre-build process, some tools need to generate a new Wrangler configuration alongside the original code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case we actually want to say alongside generated code. The "generated config" may get stored on disk in the same directory as the "generated/compiled source code".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I attempted to improve that.
|
||
### Custom build tool example | ||
|
||
A common approach that a build tool might choose to implement is to output code and configuration in a `dist` directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A common approach that a build tool might choose to implement is to output code and configuration in a `dist` directory. | |
For example, a new configuration file may be generated by a custom build tool when creating a `dist` directory. |
You may need to rewrite my suggestion if it doesn't make sense. I added this because I didn't quite understand the connection between this and the section above. I know it says "example" in the header, but I think it would also help to lead in by specifically saying that this is an example of when a new configuration file is generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to make it more example-ish
|
||
## Generated Wrangler configuration | ||
|
||
When using a framework or a custom pre-build process, some tools need to generate a modified Wrangler configuration alongside the generated code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When using a framework or a custom pre-build process, some tools need to generate a modified Wrangler configuration alongside the generated code. | |
When using a framework or a custom pre-build process, some tools need to generate a new Wrangler configuration alongside the original code. |
My main suggestion would be to pick consistent language for what you're calling the original file and the new file because you were using a bunch of different terms and I think it could be confusing. In my edits, I went with the "new, generated file" and the "original, user's file", but you can choose something else, as long as it's consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tidied up
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
Co-authored-by: ToriLindsay <[email protected]>
See cloudflare/workers-sdk#7442
Summary
Screenshots (optional)
Documentation checklist