Page MenuHomePhabricator
Differential D4969

[Docs] Fix nix store typo
ClosedPublic
Actions

Authored by • jon on Aug 26 2022, 3:49 PM.
Tags
None
Referenced Files
F6237215: D4969.diff
Thu, Apr 24, 4:22 PM
Unknown Object (File)
Sat, Apr 19, 3:18 PM
Unknown Object (File)
Sat, Apr 19, 10:05 AM
Unknown Object (File)
Sat, Apr 19, 7:58 AM
Unknown Object (File)
Sat, Apr 19, 6:38 AM
Unknown Object (File)
Sat, Apr 19, 5:59 AM
Unknown Object (File)
Sat, Apr 19, 5:52 AM
Unknown Object (File)
Sat, Apr 19, 5:08 AM
View All Files
Subscribers
atul
tomek

Details

Reviewers
varun
ashoat
• abosh
Commits
rCOMMcf19b66d22ba: [Docs] Fix nix store typo
Summary

Minor fix a typo. It's /nix/store/ not /nix/store-.

Test Plan

N/A

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• jon created this revision.Aug 26 2022, 3:49 PM
Herald added subscribers: atul, tomek. · View Herald TranscriptAug 26 2022, 3:49 PM
• jon added a parent revision: D4968: [Docs] Update supported workflow information.Aug 26 2022, 3:50 PM
Harbormaster completed remote builds in B11657: Diff 16031.Aug 26 2022, 3:59 PM
• jon requested review of this revision.Aug 26 2022, 3:59 PM
• jon added a child revision: D4970: [Docs] Provide nixified version of tableplus.Aug 26 2022, 4:38 PM
ashoat accepted this revision.Aug 26 2022, 8:41 PM
This revision is now accepted and ready to land.Aug 26 2022, 8:41 PM
• jon updated this revision to Diff 16082.Aug 29 2022, 11:13 AM

Rebase with changes

• abosh accepted this revision.Aug 29 2022, 11:15 AM
• abosh added inline comments.
docs/nix_dev_env.md
87
Harbormaster completed remote builds in B11694: Diff 16082.Aug 29 2022, 11:23 AM
• jon updated this revision to Diff 16086.Aug 29 2022, 4:52 PM

Fix respective mis-spelling

Harbormaster completed remote builds in B11697: Diff 16086.Aug 29 2022, 5:02 PM
ashoat requested changes to this revision.Sep 13 2022, 2:02 PM
ashoat added inline comments.
docs/nix_dev_env.md
87 ↗(On Diff #16086)

This section introduces more questions than it answers. For instance, "simply adding the respective toolchains to nativeBuildInputs" begs the question... what is nativeBuildInputs

I think we should either simplify the language or scrap it altogether.

This revision now requires changes to proceed.Sep 13 2022, 2:02 PM
• jon planned changes to this revision.Sep 13 2022, 3:25 PM
• jon added inline comments.
docs/nix_dev_env.md
87 ↗(On Diff #16086)

I plan to tackle this on https://github.com/divnix/nix-book/issues/21. But I can just leave off that last bit, I think

This model can be extended through shell hooks to support other build toolchains such as pkg-config, cmake, and many other language specific package managers

Is good enough for the intuition

• jon updated this revision to Diff 16724.Sep 15 2022, 5:38 PM
• jon marked 2 inline comments as done.

Simplify "How Nix introduces..." section

• jon added inline comments.Sep 15 2022, 5:39 PM
docs/nix_dev_env.md
87 ↗(On Diff #16086)

reworded the section to be simpler

• jon updated this revision to Diff 16725.Sep 15 2022, 5:44 PM

Apply suggestions

Harbormaster completed remote builds in B12193: Diff 16724.Sep 15 2022, 5:46 PM
Harbormaster completed remote builds in B12194: Diff 16725.Sep 15 2022, 5:54 PM
ashoat accepted this revision.Sep 15 2022, 7:11 PM

Great!!

This revision is now accepted and ready to land.Sep 15 2022, 7:11 PM
Closed by commit rCOMMcf19b66d22ba: [Docs] Fix nix store typo (authored by • jon). · Explain WhySep 19 2022, 3:11 PM
This revision was automatically updated to reflect the committed changes.
• jon added a commit: rCOMMcf19b66d22ba: [Docs] Fix nix store typo.

Revision Contents
Changeset List

PathSize
docs/
2 lines

Diff 16082

View Options

docs/nix_dev_env.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