Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split developer docs into per-OS files #1305

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

rmunn
Copy link
Contributor

@rmunn rmunn commented Dec 6, 2024

Fix #1265.
Fix #1260.

@rmunn rmunn self-assigned this Dec 6, 2024
README.md Outdated Show resolved Hide resolved
docs/DEVELOPER-win.md Outdated Show resolved Hide resolved
docs/DEVELOPER-linux.md Outdated Show resolved Hide resolved
It wanted us to recommend native docker for Linux users, so I wrote a
paragraph explaining why this project recommends Docker Desktop on Linux
even though native docker is available. The other recommendations were
good (typo and grammar fixes).
@rmunn rmunn requested a review from hahn-kev December 6, 2024 03:33
On Linux (only), Docker Desktop tends to spam the syslog with
debug-level messages about HTTP requests and responses. We should
provide instructions on how to silence that spam so Linux devs' /var
partitions don't fill up unexpectedly fast.
@rmunn
Copy link
Contributor Author

rmunn commented Dec 6, 2024

Just added commit ac5f873 to also fix #1260.

docs/DEVELOPER-linux.md Outdated Show resolved Hide resolved
@myieye
Copy link
Contributor

myieye commented Dec 9, 2024

@rmunn How would you feel about only using the os-specific files for os-specific details? That would:

  • Remove the redundancy
  • Make the differences much more obvious (i.e. there would probably only be 2 items in the Linux file, which would ultimately make the Docker log tip much more visible)
  • Reduce the risk of things getting out of date
  • Not force us to pretend that we know how to set up a dev environment for Mac 🍏 🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants