Page MenuHomePhabricator
Differential D4967

[Docs] Organize comprehensive nix documentation
ClosedPublic
Actions

Authored by • jon on Aug 26 2022, 3:45 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, May 14, 8:03 AM
Unknown Object (File)
Mon, May 13, 2:50 PM
Unknown Object (File)
Thu, May 9, 5:14 PM
Unknown Object (File)
Thu, May 9, 5:13 PM
Unknown Object (File)
Thu, May 9, 5:13 PM
Unknown Object (File)
Tue, May 7, 2:13 AM
Unknown Object (File)
Sat, May 4, 2:05 AM
Unknown Object (File)
Fri, May 3, 4:48 PM
View All Files
Subscribers
atul
tomek

Details

Reviewers
• abosh
varun
ashoat
Commits
rCOMM242d9adba22f: [Docs] Organize comprehensive nix documentation
Summary

Large addition of documentation specific to nix.

The content has been copied and pasted from the the existing
dev_environment.md with exception of initial headers.

Depends on D4966

Test Plan

View rendered markdown:
https://github.com/CommE2E/comm/blob/jonringer/nix-dev-docs/docs/nix_dev_env.md

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• jon created this revision.Aug 26 2022, 3:45 PM
Herald added subscribers: atul, tomek. · View Herald TranscriptAug 26 2022, 3:45 PM
• jon added a child revision: D4968: [Docs] Update supported workflow information.Aug 26 2022, 3:48 PM
Harbormaster completed remote builds in B11655: Diff 16029.Aug 26 2022, 3:54 PM
• jon requested review of this revision.Aug 26 2022, 3:54 PM
• jon updated this revision to Diff 16032.Aug 26 2022, 4:32 PM

Include homebrew and related tools: idb, reactotron

• jon mentioned this in D4970: [Docs] Provide nixified version of tableplus.Aug 26 2022, 4:38 PM
Harbormaster completed remote builds in B11658: Diff 16032.Aug 26 2022, 4:42 PM
ashoat resigned from this revision.Aug 26 2022, 8:38 PM

I don't have time to review this before I leave and @varun is already out. Hoping @abosh can take a look

ashoat mentioned this in D4968: [Docs] Update supported workflow information.Aug 26 2022, 8:40 PM
• abosh requested changes to this revision.EditedAug 27 2022, 11:13 AM

Only the content of nix_dev_env.md changed significantly. The content of the nix_*_{setup,workflows}.md are copy and pasted from the the existing dev_environment.md with exception of initial headers.

Hey @jon, can you split this diff into two, per this Notion doc? I made a similar diff once (D4399) which was quite confusing because I moved stuff and edited stuff in the same diff. You can update this one to just copy and pasting stuff from dev_environment.md and then stack another one on top of this to update nix_dev_env.md. The factoring makes it easier to review.

Moving code around: D4399
Updating code: D4414

It would also make it easier to accept the first one since it's just copied from dev_environment.md. Thanks.

This revision now requires changes to proceed.Aug 27 2022, 11:13 AM
• jon updated this revision to Diff 16077.Aug 29 2022, 10:34 AM

Only include existing documentation

• jon added a child revision: D4978: [Docs] Update nix_dev_env.md to reference relevant docs.Aug 29 2022, 10:35 AM
• jon removed a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 10:42 AM
• jon edited the summary of this revision. (Show Details)
Harbormaster completed remote builds in B11690: Diff 16077.Aug 29 2022, 10:44 AM
• abosh accepted this revision.Aug 29 2022, 11:01 AM

Thanks for updating this diff! Accepting, assuming that this code is copied and pasted from dev_environment.md outside of the "Nix" headers.

This revision is now accepted and ready to land.Aug 29 2022, 11:01 AM
• jon added a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 11:11 AM
• jon removed a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 11:14 AM
• jon added a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 2:00 PM
• jon removed a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 4:44 PM
• jon added a child revision: D4968: [Docs] Update supported workflow information.Aug 29 2022, 5:30 PM
ashoat mentioned this in D4978: [Docs] Update nix_dev_env.md to reference relevant docs.Sep 13 2022, 2:05 PM
Closed by commit rCOMM242d9adba22f: [Docs] Organize comprehensive nix documentation (authored by • jon). · Explain WhySep 19 2022, 3:11 PM
This revision was automatically updated to reflect the committed changes.
• jon added a commit: rCOMM242d9adba22f: [Docs] Organize comprehensive nix documentation.
• jon mentioned this in rCOMM15c88bf17810: [Docs] Provide nixified version of tableplus.

Revision Contents
Changeset List

Diff 16032

View Options

docs/nix_dev_env.md

Loading...
View Options

docs/nix_mobile_setup.md

Loading...
View Options

docs/nix_mobile_workflows.md

Loading...
View Options

docs/nix_shared_workflows.md

Loading...
View Options

docs/nix_web_setup.md

Loading...
View Options

docs/nix_web_workflows.md

Loading...