Conversation
Updated README to include guidance for team members to use a different link.
|
@timtronic477 is attempting to deploy a commit to the SF Civic Tech - DS Working Group's projects Team on Vercel. A member of the Team first needs to authorize it. |
![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 README.md to include a warning for team members to use the development environment for internal testing to avoid skewing production analytics. Review feedback highlights a potential inconsistency with other parts of the documentation regarding the development URL and suggests using more descriptive link text for better readability.
| ## ⚠️ Important: Use the Development Site for Internal Testing | ||
|
|
||
| When browsing, testing, or reviewing the site as a team member, always use the development version: | ||
|
|
||
| **[datasci-earthquake-omega.vercel.app](https://datasci-earthquake-omega.vercel.app)** | ||
|
|
||
| Do **not** use the production site (`safehome.report`) for internal browsing or QA. | ||
| All user interactions — including page views and clicks — are tracked via PostHog. | ||
| Visiting production inflates our analytics and skews the data we report out. | ||
|
|
||
| > If you're unsure which environment to use, default to dev. | ||
|
|
There was a problem hiding this comment.
While adding this guidance is helpful, it introduces a potential inconsistency in the documentation. This new section states that datasci-earthquake-omega.vercel.app is the development version to be used for internal testing. However, further down in the 'Production deployments' section (lines 615 and 620-624), https://develop.safehome.report is mentioned as the dev testing site deployed from the develop branch.
To avoid confusion for developers, could you please clarify the relationship between these two URLs in the README? For example:
- Are they for different purposes?
- Is one an alias for the other?
- Should the older reference to
develop.safehome.reportbe updated or removed?
Making this consistent will ensure all team members use the correct environment.
|
|
||
| When browsing, testing, or reviewing the site as a team member, always use the development version: | ||
|
|
||
| **[datasci-earthquake-omega.vercel.app](https://datasci-earthquake-omega.vercel.app)** |
There was a problem hiding this comment.
For better readability, consider using a more descriptive link text instead of the full URL. This makes the link's purpose clearer at a glance.
| **[datasci-earthquake-omega.vercel.app](https://datasci-earthquake-omega.vercel.app)** | |
| **[Development Site](https://datasci-earthquake-omega.vercel.app)** |
1 participant
Updated README to include guidance for team members to use a different link.
Description
Updated the README file to include a note about using https://datasci-earthquake-omega.vercel.app/ to help with datasci team collecting data on users
Type of changes
Testing
How to test
testing description here: i.e. run app, go to x page, see that it does y
Clean commits
¹ described here