Skip to content

Commit 65c0902

Browse files
shayne-fletchermeta-codesync[bot]
authored andcommitted
move from scripts/shaynefletcher (#1757)
Summary: Pull Request resolved: #1757 moving the hyperactor mesh book into fbcode/monarch/docs/source/books. at this point there's enough structured material (host/agent walkthrough, bootstrapping) that it should live with the rest of monarch docs instead of in my personal scratch space. this makes it discoverable for people who are trying to understand v1 and we can start iterating on it in-tree with normal review procedures rather than out-of-band. Reviewed By: mariusae Differential Revision: D86309851 fbshipit-source-id: 33a475c3ad00810d72fb18400bf89bda651698ce
1 parent d793cbb commit 65c0902

24 files changed

+3113
-0
lines changed
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Hyperactor-mesh Book
2+
3+
This is the development documentation for hyperactor-mesh, built using [`mdBook`](https://rust-lang.github.io/mdBook/).
4+
5+
## Running the Book
6+
7+
### On the **Server**
8+
9+
To run the book on a remote server (e.g., `devgpu004`):
10+
11+
```bash
12+
x2ssh devgpu004.rva5.facebook.com
13+
tmux new -s hyperactor-mesh-mdbook
14+
cd ~/fbsource/fbcode/scripts/shaynefletcher/hyperactor-mesh-book
15+
mdbook serve --port 3001
16+
```
17+
Then detach with Ctrl+b, then d.
18+
19+
### On the **Client**
20+
21+
To access the remote book from your local browser:
22+
```bash
23+
autossh -M 0 -N -L 3001:localhost:3001 devgpu004.rva5.facebook.com
24+
```
25+
Then open http://localhost:3001 in your browser.
26+
27+
**Note**: If you don’t have autossh installed, you can install it with:
28+
```bash
29+
brew install autossh
30+
```
31+
32+
### Notes
33+
34+
- The source is located in src/, with structure defined in SUMMARY.md.
35+
- The book will auto-reload in the browser on edits.
36+
37+
## Cleaning Up
38+
39+
To shut down the book server:
40+
41+
### Option 1: Reattach and stop
42+
43+
```bash
44+
x2ssh devgpu004.rva5.facebook.com
45+
tmux attach -t hyperactor-mesh-mdbook
46+
```
47+
Inside the session:
48+
- Press Ctrl+C to stop mdbook serve
49+
- Then type exit to close the shell and terminate the tmux session
50+
51+
### Option 2: Kill the session directly
52+
53+
If you don’t want to reattach, you can kill the session from a new shell:
54+
```bash
55+
x2ssh devgpu004.rva5.facebook.com
56+
tmux kill-session -t hyperactor-mesh-mdbook
57+
```
58+
59+
### Optional: View active tmux sessions
60+
```bash
61+
tmux ls
62+
```
63+
Use this to check whether the mdbook session is still running.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
authors = ["Shayne Fletcher"]
3+
language = "en"
4+
src = "src"
5+
title = "Hyperactor-mesh Book"
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Summary
2+
3+
- [Meshes](meshes/index.md)
4+
- [Bootstrapping Overview](meshes/bootstrapping-overview.md)
5+
- [1. Proc and instance](meshes/bootstrapping-proc-and-instance.md)
6+
- [2. Process allocator & v0 bootstrap](meshes/bootstrapping-process-allocator.md)
7+
- [3. HostMesh from an allocation](meshes/bootstrapping-hostmesh-from-allocation.md)
8+
- [4. Doing real work (hosts → procs → actors)](meshes/bootstrapping-doing-real-work.md)
9+
- [Boostrapping from Python](meshes/bootstrapping-from-python.md)
10+
- [Host & agents (control plane & mux)](meshes/host-and-agents.md)
11+
- [Process-backed hosts: BootstrapProcManager](meshes/bootstrap-proc-manager.md)
12+
- [Appendix: `bootstrap_canonical_simple`](meshes/bootstrapping-appendix-canonical-test.md)
13+
- [Appendix: pytokio (Python/Rust async bridge)](meshes/pytokio-appendix.md)
14+
- [Logging](logging/index.md)
15+
- [Logging Overview](logging/overview.md)
16+
- [Forwarders](logging/forwarder.md)
17+
- [Stream Forwarders](logging/stream-forwarders.md)
18+
- [Client](logging/client.md)
19+
- [Python](logging/python.md)
20+
- [Config](logging/config.md)
21+
- [Ordering](logging/ordering.md)
22+
- [Teardown](logging/teardown.md)
23+
- [File aggregation](logging/file-aggregation.md)

0 commit comments

Comments
 (0)