Page MenuHomePhabricator

[docs] Remove references to create-db.js script
ClosedPublic

Authored by ashoat on Jun 29 2022, 9:52 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Nov 8, 12:49 PM
Unknown Object (File)
Fri, Nov 8, 12:49 PM
Unknown Object (File)
Fri, Nov 8, 12:49 PM
Unknown Object (File)
Mon, Oct 28, 2:49 AM
Unknown Object (File)
Oct 15 2024, 4:18 AM
Unknown Object (File)
Oct 6 2024, 9:53 AM
Unknown Object (File)
Oct 5 2024, 1:13 AM
Unknown Object (File)
Oct 5 2024, 1:13 AM

Details

Summary

Following D4151, the keyserver migration code should automatically setup the database when it sees the meta table is missing. As a result, it's no longer necessary for the user to manually call create-db.js.

Test Plan

As part of D4151 I tested that the database gets automatically set up if it has no tables

Diff Detail

Repository
rCOMM Comm
Branch
ashoat/docs
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

(removed myself as reviewer bc docs diff, feel free to add back if there's something specific I might have context on)

docs/dev_environment.md
546

Couple changes I noticed that could be made here.

we'll first need to use Babel...

I modified this to "we'll use Babel" since it seemed less wordy and more concise while carrying the same meaning. The "first" is implied by the ordering of the sentences and the commands below it (yarn babel-build before everything else).

We also use...

Changed "We" to "We'll" since the tense of the rest of the paragraph is future tense. Some examples:

we'll first need to use Babel ...

Babel will transpile the files in ...

546

I like this change from "Now let's run a script to ..."

Accepting, because the scope of this diff is to remove references to create-db.js. But in the process of reviewing, saw some minor minor wording changes that could be made. Up to you and rest of reviewers.

This revision is now accepted and ready to land.Jun 29 2022, 1:13 PM
docs/dev_environment.md
546

Thanks, I mostly took your advice but kept "need to"... I think the "Before we can X we need to Y" construction makes more sense than "Before we can X we'll Y" since it clarifies that step Y is necessary for step X to work

(I also fixed up your single-quote to an apostrophe)