Skip to content

docs: update docker install section - #646

Open
fyliu wants to merge 1 commit into
hackforla:mainfrom
fyliu:645-update-docker-docs
Open

docs: update docker install section#646
fyliu wants to merge 1 commit into
hackforla:mainfrom
fyliu:645-update-docker-docs

Conversation

@fyliu

@fyliu fyliu commented Mar 6, 2026

Copy link
Copy Markdown
Member

Fixes #645

What changes did you make?

  • mainly adding note to do post-install steps
  • see before and after descriptions for other improvements

Why did you make the changes (we will use this info to test)?

  • the post-install is needed for running docker as the normal user
  • see before and after descriptions for others

Screenshots of Proposed Changes

beforeafter
2026-03-05_20-22 2026-03-05_20-40
- docker compose not needed anymore, since it's part of docker now.
- installation link target is really small.
- added short description of what it does and how it benefits us
- larger installation link
- added note about post-install
2026-03-05_20-19 2026-03-05_20-21
- complicated docker vs. docker desktop instructions
- systemctl command is not portable across Linuxes.
- step description the same as the command
- long step that should be split up - it' s really 2 things
- simplified step that works for both docker and docker desktop
- complexity hidden behind the + sign
- simplified description
- split long step into 2 parts, with better quoting
2026-03-05_20-55
- content that's shown when clicking on the +
- explains what the command should do, and the common failure case and solution that includes both docker and docker desktop.

@fyliu
fyliu force-pushed the 645-update-docker-docs branch from c42c8a5 to c254c03 Compare March 6, 2026 05:04
@fyliu fyliu moved this to PR Needs review (automated column, do not place items here manually) in P: PD: Project Board Mar 6, 2026
@fyliu
fyliu force-pushed the 645-update-docker-docs branch from c254c03 to cfb8605 Compare March 20, 2026 23:29
@fyliu
fyliu force-pushed the 645-update-docker-docs branch from cfb8605 to 533d83e Compare May 20, 2026 23:48
@fyliu fyliu assigned fyliu and unassigned ExperimentsInHonesty May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: PR Needs review (automated column, do not place items here manually)

Development

Successfully merging this pull request may close these issues.

Update documentation about docker

2 participants