hackforla / hackforla/peopledepot

Update documentation about docker

Open
#645 0 comments 0 reactions 1 assignee Claimed by @fyliu View on GitHub
complexity: small feature: docs: PD team documentation PII: FALSE role: dev lead size: 0.5pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We are striving to write documentation that helps developers on our team and our stakeholders' teams work smoothly and successfully.

We need to add text to direct Linux users to do the post-install steps after installing Docker so that developers can run Docker as the non-root user.

### Documentation Notes

- [x] A note to say users should run the post-install steps after installing Docker.
- [x] The Install Docker section should also tell people to install Docker only, since docker compose now comes with Docker and doesn't need to be installed separately (I verified it with a clean install of Debian Trixie).
- [x] The "Make sure the Docker service is running" for Docker (engine) needs updating. Systemctl is a systemd command and doesn't apply to all Linuxes. Revert back to the "docker ps" we had before or rewrite it.

#### Where would this information have been useful?

- Development Environment > [Install Docker section][install-docker-section]
- [Build and run using Docker locally][build-and-run-using-docker] - for "Make sure Docker service is running"

#### Which roles will benefit most from this information?

- developers during onboarding doing development environment setup

### Action Items

- [x] add the relevant text to [1.01](#1.01), [1.02](#1.02)

### Resources/Instructions/Tags


- 1.01 [Install Docker section][install-docker-section]

- 1.02 [Build and run using Docker locally][build-and-run-using-docker]
- 1.03 tags: onboarding, docker

[install-docker-section]: https://hackforla.github.io/peopledepot/contributing/onboarding/dev_environment/#install-docker
[build-and-run-using-docker]: https://hackforla.github.io/peopledepot/contributing/onboarding/dev_environment/#build-and-run-using-docker-locally

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.