Skip to content

Commit 8234f84

Browse files
docs: genericize local username/path references for a public repo
Replace machine-specific `faqih` user and absolute home path with generic wording ($USER / /path/to/postgresql-fdw) so the docs read cleanly for anyone. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent fa316b8 commit 8234f84

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/01-REQUIREMENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
- [ ] **Docker Compose v2** (the `docker compose` subcommand) — check: `docker compose version`
1111
- [ ] **GNU Make** (optional but recommended) — check: `make --version`
1212
- [ ] **Git** — to clone & version this repo
13-
- [ ] Your user can run Docker **without `sudo`**. On this laptop `faqih` is
14-
**not** in the `docker` group yet, so docker commands currently need
15-
`sudo`. Fix it once (recommended) so `make` works cleanly:
13+
- [ ] Your user can run Docker **without `sudo`**. If your user is **not** in
14+
the `docker` group yet, docker commands will need `sudo`. Fix it once
15+
(recommended) so `make` works cleanly:
1616
```bash
1717
sudo usermod -aG docker $USER
1818
# then log out and back in (or: newgrp docker) for it to take effect

docs/02-INSTALLATION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
55
## 2.0 Docker permissions (one-time, do this first)
66

7-
On this laptop the `faqih` user is **not** in the `docker` group, so `docker`
8-
and `make` will fail with `permission denied ... /var/run/docker.sock`. Fix once:
7+
If your user is **not** in the `docker` group, `docker` and `make` will fail
8+
with `permission denied ... /var/run/docker.sock`. Fix once:
99

1010
```bash
1111
sudo usermod -aG docker $USER

docs/07-BACKUP-RESTORE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ docker compose exec -T postgres pg_dump -U local_dev -d local_db \
5757

5858
```cron
5959
# crontab -e → daily at 02:30
60-
30 2 * * * cd /home/faqih/Documents/projects/me/postgresql-fdw && make backup >> backups/cron.log 2>&1
60+
30 2 * * * cd /path/to/postgresql-fdw && make backup >> backups/cron.log 2>&1
6161
```
6262

6363
**Option B — in-database with pg_cron** (logical dump still needs the host, but

0 commit comments

Comments
 (0)