Update redirects README to reflect current behavior. - #6593
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request corrects misleading documentation regarding how redirect mappings are processed by the server. By clarifying that the configuration is read during initialization, it ensures that team members understand the necessity of a deployment cycle for applying changes to redirects. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in server/routes/redirects/README.md to clarify that the redirects.json file is read by the Flask server on startup, meaning a rollout or restart is required for any changes to take effect in production. There are no review comments, so I have no feedback to provide.
| The `redirects.json` file in this directory is stored in a GCS bucket and | ||
| read by the production Flask server on each redirection call (to achieve | ||
| immediate update without rollout/restart). | ||
| read by the Flask server on server start. A rollout/restart is required |
There was a problem hiding this comment.
I remember now - I may have changed the behavior.
this used to always read from GCS which felt extremely wasteful. So changed it so that it loads on startup. I just didnt fix this documentation :)
Thank you!
There was a problem hiding this comment.
The new behavior is much better, especially given how rarely we actually change these redirects!
…6593) ## Description The README.md in `server/routes/redirects/README.md` that describes how to update redirect mapping is incorrect/out-of-date. While the description of how to update the mapping (via the `gcloud storage cp`) is correct, the description of when those changes are picked up by production is not. The file states that production reads this redirect mapping on each redirection call, resulting in the immediate pickup of these changes. This is incorrect. The bucket is read when the Flask server starts (in `__init__.py`). This PR updates the README.md to correct the description.
2 participants
Description
The README.md in
server/routes/redirects/README.mdthat describes how to update redirect mapping is incorrect/out-of-date.While the description of how to update the mapping (via the
gcloud storage cp) is correct, the description of when those changes are picked up by production is not.The file states that production reads this redirect mapping on each redirection call, resulting in the immediate pickup of these changes. This is incorrect. The bucket is read when the Flask server starts (in
__init__.py).This PR updates the README.md to correct the description.