[docs] Remove 'network.json' mentions
ClosedPublic
Actions

Authored by bartek on Jan 19 2023, 12:46 AM.

Details

Reviewers

ashoat
inka

Group Reviewers

Restricted Owners Package

(Owns No Changed Paths)

Commits

rCOMMabe832b337bc: [docs] Remove 'network.json' mentions

Summary

Resolves ENG-2727.

Removed docs references to network.json and updated the section to mention the COMM_NAT_DEV_HOSTNAME env var instead.

Test Plan

Ensured markdown is rendering correctly.

Repository

rCOMM Comm

Branch

barthap/network-json-docs

Lint

No Lint Coverage

Unit

No Test Coverage

bartek held this revision as a draft.

bartek added a reviewer: Restricted Owners Package.Jan 19 2023, 12:48 AM

bartek published this revision for review.Jan 19 2023, 12:58 AM

bartek added a reviewer: inka.

Please address comments before landing (and please apply nits to both files)

docs/dev_environment.md
656	Nit: use an apostrophe instead of a single-quote in "machine's"
662	Just making sure, did you test this? I'm not familiar with how environmental variables get forwarded through `package.json` scripts – I just want to make sure that it will forward through to `yarn start`
667	Nit: use an apostrophe instead of a single-quote in "developer's"

This revision is now accepted and ready to land.Jan 19 2023, 8:05 AM

docs/dev_environment.md
656	Wow, I didn't realize they're different characters. Thanks!
662	Yes, I use this strategy pretty often, Yarn passes-through environment variables. Of course, this syntax doesn't work on Windows, though.