mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
3dffdefd6e
Closes DOCS-1057 Contributes to DOCS-1052 ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem We have hundreds of MDX lint warnings in our docs going against style best practices. ## Solution Remove and replace in context the following: - PostgreSQL. There was only one. There was concern about exceptions, but I found none. - Just - Quickly - Actually ### What changed Edits follow the [Google developer documentation style guide](https://developers.google.com/style): concise, direct, active voice. The flagged words were removed when the sentence still read well, or replaced when meaning needed to be preserved. ### Common patterns | Flagged word | Approach | Example | |---|---|---| | **just** (filler) | Removed | "you just installed" → "you installed" | | **just** (limiting) | **only** | "just one row" → "only one row" | | **just like** | **like** / **the same as** | "function just like regular users" → "function like regular users" | | **not just** | **not only** | "not just errors" → "not only errors" | | **quickly** (performance) | **efficiently** or removed | "find rows quickly" → "find rows efficiently" | | **quickly** (time) | **soon** / **rapidly** / removed | "expires too quickly" → "expires too soon" | | **actually** (filler) | Removed | "actually execute" → "execute"; "is actually the most common" → "is the most common" | ## Tophatting 1. See the diff. 2. See that content continues to make sense in context. 3. Locally, `cd apps/docs` and run `pnpm run lint:mdx`. 4. Search for "just," "actually," "quickly", and "PostgreSQL" and see there are 0 warnings. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated wording across quickstarts, guides, and troubleshooting articles for grammar, clarity, and consistent step-by-step phrasing. * Clarified key concepts including Row Level Security policy evaluation across Supabase products, deferred foreign key constraint behavior, and when `EXPLAIN ANALYZE` executes queries (and related side effects). * Refined several troubleshooting instructions and added guidance to cap log payload size to reduce billed Logs Ingest volume. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Nik Richers <nrichers@gmail.com> Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
129 lines
2.9 KiB
Plaintext
129 lines
2.9 KiB
Plaintext
<Tabs
|
|
scrollable
|
|
size="small"
|
|
type="underlined"
|
|
defaultActiveId="windows"
|
|
>
|
|
|
|
<TabPanel id="windows" label="Windows">
|
|
|
|
<StepHikeCompact>
|
|
|
|
<StepHikeCompact.Step step={1}>
|
|
|
|
<StepHikeCompact.Details title="Install Postgres" fullWidth>
|
|
|
|
Download and run the installation file for the latest version from the [Postgres installer download page](https://www.postgresql.org/download/windows/).
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
<StepHikeCompact.Step step={2}>
|
|
|
|
<StepHikeCompact.Details title="Add Postgres to your system PATH" fullWidth>
|
|
|
|
Add the Postgres binary to your system PATH.
|
|
|
|
In Control Panel, under the Advanced tab of System Properties, click Environment Variables. Edit the Path variable by adding the path to the SQL binary you installed.
|
|
|
|
The path will look something like this, though it may differ slightly depending on your installed version:
|
|
|
|
```
|
|
C:\Program Files\PostgreSQL\17\bin
|
|
```
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
<StepHikeCompact.Step step={3}>
|
|
|
|
<StepHikeCompact.Details title="Verify that psql is working" fullWidth>
|
|
|
|
Open your terminal and run the following command:
|
|
|
|
```sh
|
|
psql --version
|
|
```
|
|
|
|
<Admonition type="tip">
|
|
|
|
If you get an error that psql is not available or cannot be found, check that you have correctly added the binary to your system PATH. Also try restarting your terminal.
|
|
|
|
</Admonition>
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
</StepHikeCompact>
|
|
|
|
</TabPanel>
|
|
|
|
<TabPanel id="mac" label="MacOS">
|
|
|
|
<StepHikeCompact>
|
|
|
|
<StepHikeCompact.Step step={1}>
|
|
|
|
<StepHikeCompact.Details title="Install Homebrew" fullWidth>
|
|
|
|
Install [Homebrew](https://brew.sh/).
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
<StepHikeCompact.Step step={2}>
|
|
|
|
<StepHikeCompact.Details title="Install Postgres" fullWidth>
|
|
|
|
Install Postgres via Homebrew by running the following command in your terminal:
|
|
|
|
```sh
|
|
brew install postgresql@17
|
|
```
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
<StepHikeCompact.Step step={3}>
|
|
|
|
<StepHikeCompact.Details title="Verify that psql is working" fullWidth>
|
|
|
|
Restart your terminal and run the following command:
|
|
|
|
```sh
|
|
psql --version
|
|
```
|
|
|
|
If you get an error that psql is not available or cannot be found then the PATH variable is likely either not correctly set or you need to restart your terminal.
|
|
|
|
You can add the Postgres installation path to your PATH variable by running the following command:
|
|
|
|
```sh
|
|
brew info postgresql@17
|
|
```
|
|
|
|
The above command will give an output like this:
|
|
|
|
```sh
|
|
If you need to have postgresql@17 first in your PATH, run:
|
|
|
|
echo 'export PATH="/opt/homebrew/opt/postgresql@17/bin:$PATH"' >> ~/.zshrc
|
|
```
|
|
|
|
Run the command mentioned and restart the terminal.
|
|
|
|
</StepHikeCompact.Details>
|
|
|
|
</StepHikeCompact.Step>
|
|
|
|
</StepHikeCompact>
|
|
|
|
</TabPanel>
|
|
|
|
</Tabs>
|