Page MenuHomePhabricator
Differential D4404

[docs] updated dev env docs for protobuf edge case
ClosedPublic
Actions

Authored by • derek on Jun 29 2022, 12:06 PM.
Tags
None
Referenced Files
F6237396: D4404.diff
Thu, Apr 24, 4:33 PM
Unknown Object (File)
Tue, Apr 22, 3:26 PM
Unknown Object (File)
Tue, Apr 22, 3:26 PM
Unknown Object (File)
Tue, Apr 22, 3:26 PM
Unknown Object (File)
Mon, Apr 21, 3:39 PM
Unknown Object (File)
Mon, Apr 21, 3:39 PM
Unknown Object (File)
Mon, Apr 21, 3:39 PM
Unknown Object (File)
Mon, Apr 21, 3:39 PM
View All Files
Subscribers
• abosh
• adrian
ashoat
atul
tomek

Details

Reviewers
ashoat
varun
• abosh
atul
Commits
rCOMM037d3f89d54a: [docs] updated dev env docs for protobuf edge case
Test Plan

just tested the solution

Diff Detail

Repository
rCOMM Comm
Branch
derek/siwe-phab
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• derek created this revision.Jun 29 2022, 12:06 PM
Herald added subscribers: • abosh, atul, • adrian and 2 others. · View Herald TranscriptJun 29 2022, 12:06 PM
• derek added a comment.EditedJun 29 2022, 12:10 PM

i tried to undo the spacing change on the arc diff line but it's giving me empty git error

Harbormaster completed remote builds in B10111: Diff 13976.Jun 29 2022, 12:19 PM
• derek requested review of this revision.Jun 29 2022, 12:19 PM
• derek added reviewers: ashoat, atul.Jun 29 2022, 12:28 PM
• derek added reviewers: varun, • abosh.
ashoat added inline comments.Jun 29 2022, 12:29 PM
docs/dev_environment.md
822 ↗(On Diff #13976)

You removed a space following "Differential Revision:"

ashoat requested changes to this revision.Jun 29 2022, 12:30 PM
ashoat added inline comments.
docs/dev_environment.md
323 ↗(On Diff #13976)
  1. Can we say `In the event that Homebrew installs Protobuf anyway"?
  2. Can we put the new sentence on a new paragraph? I think it will be harder to miss that way
This revision now requires changes to proceed.Jun 29 2022, 12:30 PM
atul resigned from this revision.Aug 15 2022, 9:47 AM

Resigning because docs diff.

• derek updated this revision to Diff 16007.Aug 26 2022, 9:14 AM

Updating D4404: Summary: updated dev env docs for protobuf edge case, responded to diff comments

Harbormaster failed remote builds in B11640: Diff 16007!Aug 26 2022, 9:15 AM
• derek added a comment.EditedAug 26 2022, 9:17 AM

@ashoat as per your comment I fixed the spacing on line 822 in my last commit - my guess is flow (or some other part of the precommit hook) is linting that space. i'll reach out to dev & find someone to help me troubleshoot that

• derek updated this revision to Diff 16008.Aug 26 2022, 9:33 AM

Updating D4404: fixed whitespace

Harbormaster failed remote builds in B11641: Diff 16008!Aug 26 2022, 9:33 AM
• derek updated this revision to Diff 16009.Aug 26 2022, 9:36 AM

Updating D4404: rebased

Harbormaster completed remote builds in B11642: Diff 16009.Aug 26 2022, 9:46 AM
• abosh accepted this revision.Aug 26 2022, 11:07 AM
• abosh added 2 blocking reviewer(s): ashoat, varun.

Don't know if @ashoat will be able to review anytime soon, but him or Varun should take a look at it. I think you can remove one or the other as blocking once they do, since @ashoat already looked at this diff and you seem to have incorporated his feedback.

ashoat accepted this revision.Aug 26 2022, 12:09 PM

Make sure to make the inline changes before landing

docs/dev_environment.md
327 ↗(On Diff #16009)
  1. "installs" appears twice
  2. s/anyway/anyways/
• abosh retitled this revision from Summary: updated dev env docs for protobuf edge case to [docs] updated dev env docs for protobuf edge case.Aug 26 2022, 1:26 PM
• abosh removed 1 blocking reviewer(s): varun.
This revision is now accepted and ready to land.Aug 26 2022, 1:26 PM
• derek updated this revision to Diff 16209.Sep 1 2022, 9:57 AM

removed duplicate "install"

This revision was landed with ongoing or failed builds.Sep 1 2022, 9:57 AM
Closed by commit rCOMM037d3f89d54a: [docs] updated dev env docs for protobuf edge case (authored by • derek). · Explain Why
This revision was automatically updated to reflect the committed changes.
• derek added a commit: rCOMM037d3f89d54a: [docs] updated dev env docs for protobuf edge case.
Harbormaster completed remote builds in B11806: Diff 16209.Sep 1 2022, 10:07 AM

Revision Contents
Changeset List

PathSize
docs/
2 lines

Diff 16209

View Options

docs/dev_environment.md

# Motivation # Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us: We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command - Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools - Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system - Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html). For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows # Supported workflows
| Workflow | macOS supported | | Workflow | macOS supported |
| ------------------------------- | --------------- | | ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ | | `keyserver` (Node.js) | ✅ **†** |
| `web` (Webpack) | ✅ | | `web` (Webpack) | ✅ **†** |
| `native` iOS (React Native) | ❌ **†** | | `native` iOS (React Native) | ✅ **†** |
| `native` Android (React Native) | ❌ **†** | | `native` Android (React Native) | ✅ **†** |
aboshUnsubmitted
Done
Inline Actions

At this point, nearly every workflow requires additional steps. Maybe we can think about a way to make this seem better in the future -- users should know before reading the footnote that Nix isn't going to do everything for them. But, it will do most of the work for them, and anything else will be smaller.

While the user might still know this, the footnote isn't really helping right now. It makes it seem like we told them Nix will do a lot of things, and then later slid in that they will have to do more things.

Currently, the footnote for these sections has a lot of examples for "additional steps." Plus, "additional steps" is broad and could mean any amount of steps, especially to a user who has no familiarity with the dev environment.

So we should think about that, since most of the time footnotes should be used sparingly. If they end up affecting a large portion of a section, we should just make it information the user knows outside of just the footnote. But this can be a separate issue.

abosh: At this point, nearly every workflow requires additional steps. Maybe we can think about a way…
jonAuthorUnsubmitted
Done
Inline Actions

I originally wrote this before the prerequisite section existed. I can just reference that section now.

Probably be a better user experience anyway.

Would you like me to just reference the section? ... I went ahead and just referenced it anyway.

jon: I originally wrote this before the prerequisite section existed. I can just reference that…
aboshUnsubmitted
Done
Inline Actions

Perfect! This is much better and explicitly links a section that users can find easily.

abosh: Perfect! This is much better and explicitly links a section that users can find easily.
| C++ services | ❌ **\*** | | C++ services | ❌ **\*** |
| Rust services | ✅ | | Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK). **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, browser extensions, Flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

I don't think we need the "optional," that can be made clearer in the actual documentation for React/Redux Dev Tools. Here, in a footnote, it's not as necessary.

abosh: I don't think we need the "optional," that can be made clearer in the actual documentation for…
jonAuthorUnsubmitted
Done
Inline Actions

Right, but it was never clear in the original documentation what is optional or not. Same with Flipper and idb.

I can also just remove the statement and replace it with a link to prerequisite section

jon: Right, but it was never clear in the original documentation what is optional or not. Same with…
jonAuthorUnsubmitted
Done
Inline Actions

Removed this comment in favor of just referencing the prerequisite section.

jon: Removed this comment in favor of just referencing the prerequisite section.
aboshUnsubmitted
Done
Inline Actions
| Rust services | ✅ |
- **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or Android NDK).
+ **†** Workflow requires some additional steps after Nix installation (e.g. installing XCode, XCode profile, optional browser extensions, flipper, `idb`, `reactotron`, Android Studio, or the Android NDK).
**\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.

Should this be "the" Android NDK?

abosh: Should this be "the" Android NDK?
jonAuthorUnsubmitted
Done
Inline Actions

If I switch Studio and NDK, I think it would sounds odd to me either way reactotron, the Android NDK, or Android Studio.

I can add it.

jon: If I switch Studio and NDK, I think it would sounds odd to me either way `reactotron, the…
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available. **\*** Workflow requires documentation; and it requires the RabbitMQ and AWS/Localstack services to be available.
aboshUnsubmitted
Done
Inline Actions

What exactly does this mean?

abosh: What exactly does this mean?
jonAuthorUnsubmitted
Done
Inline Actions

It means that it's still in active development for nix support. It's largely documented here: https://github.com/CommE2E/comm/blob/master/docs/dev_services.md.

https://www.notion.so/commapp/Nix-Dev-Env-Status-170d0600d2a447fa840eb720fb11e951 will probably give you a better overview of the status; @ashoat didn't want this level of detail in user facing documentation.

jon: It means that it's still in active development for nix support. It's largely documented here…
aboshUnsubmitted
Done
Inline Actions

Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.

abosh: Yeah I agree with @ashoat here. It's more confusing than helpful to the reader.
# Requirements # Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine. To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites # Prerequisites
## Nix package manager ## Nix package manager
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines