Page MenuHomePhabricator

[docs] add instructions for creating a new user
ClosedPublic

Authored by varun on Jun 30 2022, 12:29 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Sep 17, 8:23 AM
Unknown Object (File)
Mon, Sep 2, 3:08 PM
Unknown Object (File)
Aug 28 2024, 12:21 AM
Unknown Object (File)
Aug 11 2024, 9:01 AM
Unknown Object (File)
Aug 8 2024, 1:52 PM
Unknown Object (File)
Aug 8 2024, 1:52 PM
Unknown Object (File)
Aug 8 2024, 1:52 PM
Unknown Object (File)
Aug 8 2024, 1:52 PM

Details

Summary

We instruct the developer to create a new user through the iOS simulator.

Test Plan

This is how I've created new users locally in the past

Diff Detail

Repository
rCOMM Comm
Branch
ENG-931
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

docs/dev_environment.md
763 ↗(On Diff #14044)

Quotation marks instead of double quotes.

It feels like every docs diff runs into this with quotation marks and apostrophes. If only there was a way to fix this, like with a linter or script or something. Manually checking each one can be annoying, but also a find-and-replace solution isn't that bad either. It just mainly stems from the fact that we edit docs in an IDE or text editor, which is configured to use double quotes and single quotes by default.

docs/dev_environment.md
763 ↗(On Diff #14044)

Some nits:

  1. missing a "the" – "on the iOS simulator"
  2. "on the app" -> "in the app"
  3. "in your local MySQL" -> "on your local MySQL"
docs/dev_environment.md
763 ↗(On Diff #14044)

We refer to iOS Simulator with a capital S in the rest of the docs.

763 ↗(On Diff #14044)

Maybe explicitly state these instructions or link to them in the doc, e.g. something like "under the "Running keyserver" and "Running mobile app on iOS Simulator" instructions of this document."

abosh added inline comments.
docs/dev_environment.md
763 ↗(On Diff #14044)

missing a "the" – "on the iOS simulator"

@ashoat we refer to iOS Simulator as "iOS Simulator" (no "the") in the rest of the docs. For example, "Running mobile app on iOS Simulator" is the title of one of the sections.

This revision now requires changes to proceed.Jun 30 2022, 12:44 PM
docs/dev_environment.md
763 ↗(On Diff #14046)

Technically that quotation mark is backwards 😂

This revision now requires changes to proceed.Jun 30 2022, 1:11 PM

copied quotation marks from maybe the only other place it was wrong... fixed both

Cool! Thanks for doing that.

This revision is now accepted and ready to land.Jun 30 2022, 1:41 PM