Page MenuHomePhabricator

[Docs] Provide nixified version of tableplus
ClosedPublic

Authored by jon on Aug 26 2022, 4:38 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, May 1, 12:07 PM
Unknown Object (File)
Sun, Apr 21, 11:49 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Unknown Object (File)
Thu, Apr 18, 4:23 PM
Subscribers

Details

Summary

I tried to keep D4967 mostly true to the existing documentation.
TablePlus required some changes, so separated it into another revision.

Depends on D4969

Test Plan

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Add directions on how to determine <user>

I don't have time to review this before I leave and @varun is already out. Hoping @abosh can take a look

abosh added inline comments.
docs/nix_shared_workflows.md
13–15 ↗(On Diff #16035)

Do we have to include info about Host (localhost), Password (the one you made when initializing the MariaDB server in the previous step), or Port (3306 by default)?

14 ↗(On Diff #16035)
14 ↗(On Diff #16035)
15 ↗(On Diff #16035)

Match the formatting used on the other lines (values in parentheses).

15 ↗(On Diff #16035)

Should this be "your username" or something similar? Is it clear what "your user" means to a user or can this be clearer?

This revision now requires changes to proceed.Aug 27 2022, 12:44 AM
jon marked 5 inline comments as done.

Address comments

docs/nix_shared_workflows.md
13–15 ↗(On Diff #16035)

For tableplus, no

15 ↗(On Diff #16035)

This is distinct from the prompt you see when you log into the computer. I could also ask the user to do echo $MYSQL_UNIX_PORT which will also contain this port.

15 ↗(On Diff #16035)
  • User

I'm not asking them for the user though, the socket path needs to look like /Users/jon/.local/share/MariaDB/mysql.sock.

Going to ask for socket path

almost done!

docs/nix_shared_workflows.md
14–15 ↗(On Diff #16074)

I'm not asking them for the user though, the socket path needs to look like /Users/jon/.local/share/MariaDB/mysql.sock.

Going to ask for socket path

Ok got it. What about something like this then? Since it's on the same line it's clearer that they're related (the socket path needs to be entered along with checking Use socket)

Also pedantic, but unsure if we should do “Use socket”. vs “Use socket.” I think the correct thing to do is the latter, but it's up to you.

13–15 ↗(On Diff #16035)

Wait, really? I'm asking because in dev_environment.md we include all those details, and shouldn't the setup be the same? Why wouldn't it be?

This revision now requires changes to proceed.Aug 29 2022, 10:39 AM
jon marked 2 inline comments as done.

Address comments

ashoat requested changes to this revision.Sep 13 2022, 2:09 PM
ashoat added inline comments.
docs/nix_shared_workflows.md
7 ↗(On Diff #16089)

I recognize this is copy-pasted, but I noticed two sentences in a row here that start with "After". See inline suggestion

9 ↗(On Diff #16089)

I recognize that this is copy-pasted, but I think it's weird that we're using bullet points here. Can we just combine this sentence with the previous paragraph?

13–14 ↗(On Diff #16089)

Previously, there was a consistent format here: - Field name (text). Now the format seems inconsistent...

Maybe we should just replace Name (Comm) with a sentence? See the suggested edit

This revision now requires changes to proceed.Sep 13 2022, 2:09 PM
jon added inline comments.
docs/nix_shared_workflows.md
14–15 ↗(On Diff #16074)

“Use socket”. seems better to me. As the that's how the option is displayed.

13–15 ↗(On Diff #16035)

The unix socket is convenient because it allows you to use mariadb without having to set up a privileged user. Although I do this for this for the db_config.json anyway, it also allows for me not to have the user copy those details.

I think the unix socket is a better experience for development, so I would rather use it. Both workflows work after mariadb is started with nix develop.

jon marked 3 inline comments as done.

Address comments

Apply the changes to the right file....

This revision is now accepted and ready to land.Sep 19 2022, 2:02 PM