Repository navigation
docs(self-hosted): remove invalid mentions of copying .env.custom and various minor improvements - #19797
docs(self-hosted): remove invalid mentions of copying .env.custom and various minor improvements#19797aldy505 wants to merge 1 commit into
Conversation
… various minor improvements
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
The change only edits copy on one upgrade guide. The new wording has no metric. Services: Mention PlanWhat changedThe self-hosted upgrade guide now tells readers to upgrade every month. RiskBad copy can send operators through a wrong upgrade path. Site metrics cannot show that harm. Intended effectThis is a documentation copy edit. No metric shows the new sentences on the page. Regression watchA failed render shows first as a 5xx on self-hosted URLs or as a drop in those page loads.
The changed page had 13 sampled loads in that window at Not observableThe live HTML of the new copy is not in Sentry. |
| Finally, to upgrade, run `./install.sh`. Upon completion, run `docker compose up --wait` (or if you have `.env.custom` file, run `docker compose --env-file .env --env-file .env.custom up --wait`). | ||
|
|
There was a problem hiding this comment.
Bug: Removing the instruction to update .env.custom from the upgrade guide may cause users to miss new environment variables, leading to misconfiguration after an upgrade.
Severity: MEDIUM
Suggested Fix
Restore the guidance in releases.mdx that instructs users with a .env.custom file to check for and copy new environment variables from the .env file during an upgrade. Alternatively, add a cross-reference link from the upgrade page to the configuration documentation that details this process.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: develop-docs/self-hosted/releases.mdx#L40-L41
Potential issue: The removal of guidance from `releases.mdx` regarding the `.env.custom`
file creates a risk of misconfiguration for users during an upgrade. When a
`.env.custom` file exists, the standard `.env` file is ignored. New versions of Sentry
may introduce new environment variables in the `.env` file. Without the explicit
instruction in the upgrade guide, users with a `.env.custom` setup are likely to miss
these new variables, which can lead to incorrect behavior or broken features after the
upgrade is complete.
Did we get this right? 👍 / 👎 to inform future reviews.
DESCRIBE YOUR PR
Changing some copy, as I hope it will make first timers understand our release cadence & how often they should upgrade, better.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: