singhvishalkr opened a new pull request, #1124:
URL: https://github.com/apache/pulsar-site/pull/1124

   ## Motivation
   
   Fixes #23137.
   
   The docker-compose quickstart currently tells users to run:
   
   ```bash
   sudo mkdir -p ./data/zookeeper ./data/bookkeeper
   # this step might not be necessary on other than Linux platforms
   sudo chown -R 10000 data
   ```
   
   On macOS/Windows (Docker Desktop) the `chown -R 10000` step is both 
unnecessary -- Docker Desktop's VM handles uid remapping for bind mounts -- 
**and** actively breaks the stack: `docker compose up` fails with permission 
errors on `./data/...` because the mounted directory ends up in a state the 
in-container user can't write.
   
   The existing one-line comment (*"this step might not be necessary on other 
than Linux platforms"*) is too easy to miss and doesn't tell the user what to 
do when it already broke.
   
   ## Modifications
   
   - Rewrite the Linux instruction so the Linux path is unchanged.
   - Add a `:::note macOS and Windows (Docker Desktop)` admonition that:
     - explains *why* chown isn't needed on Desktop hosts,
     - warns that running `sudo chown -R 10000` will typically break `docker 
compose up`,
     - gives the recovery recipe (delete `./data`, recreate without `chown`, 
retry).
   - Applied to the unversioned `docs/` and the 3 most recent LTS versioned 
docs (`3.3.x`, `4.1.x`, `4.2.x`). Older versioned docs (2.x, 3.0-3.2, 4.0.x) 
are intentionally not touched.
   
   ## Verifying this change
   
   Render `docs/getting-started-docker-compose.md` — the Linux snippet 
must be unchanged; a new admonition should appear after the Linux block 
explaining the Desktop scenario.
   
   ## Does this pull request potentially affect one of the following parts:
   
   - [x] `The docs`
   
   ## Documentation
   
   - [x] `doc`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to