Clarify Section 0 setup language
This commit is contained in:
42
README.md
42
README.md
@@ -1,17 +1,23 @@
|
||||
# Section 0 RTA Handbook
|
||||
# Section 0 Shared Docs
|
||||
|
||||
This hosted Git repo is intentionally plain Markdown. It has no required RTA
|
||||
sidecars. Collaborators clone, edit, commit, and push it as the canonical
|
||||
documentation source. The projection operator reads a separate projector
|
||||
checkout and mirrors the Markdown into AFFiNE as read-only docs.
|
||||
These documents are available in two ways:
|
||||
|
||||
1. Read them in AFFiNE.
|
||||
AFFiNE is the shared reading and whiteboard space. The Markdown docs from
|
||||
this repo appear there as read-only copies.
|
||||
|
||||
2. Edit them in Git.
|
||||
The editable files live in this plain Markdown repo. Use your normal editor,
|
||||
then commit and push changes.
|
||||
|
||||
If you want to change one of these docs, edit the Markdown file. Do not edit
|
||||
the AFFiNE copy; it will be refreshed from Git.
|
||||
|
||||
## What To Edit
|
||||
|
||||
Edit Markdown files in this Git repo. Do not edit the projected AFFiNE copies
|
||||
directly; AFFiNE is the shared reading and canvas surface, not the source of
|
||||
truth for these files.
|
||||
Edit Markdown files in this Git repo.
|
||||
|
||||
Current projected docs:
|
||||
Current docs:
|
||||
|
||||
- `README.md`
|
||||
- `rta/concept.md`
|
||||
@@ -19,7 +25,7 @@ Current projected docs:
|
||||
|
||||
## First-Time Setup
|
||||
|
||||
From any machine that can reach the lab mesh:
|
||||
From any machine that can reach the private lab network:
|
||||
|
||||
```sh
|
||||
curl -fsSL http://100.64.0.1:30087/section0/rta-handbook/raw/branch/main/scripts/setup-section0-docs.sh | sh
|
||||
@@ -57,14 +63,13 @@ MESSAGE="Describe the doc change" section0-docs commit
|
||||
section0-docs push
|
||||
```
|
||||
|
||||
After a push, ask the projection operator to pull and project. For now that is
|
||||
manual. The current operator command lives in
|
||||
`docs/projection-operations.md`.
|
||||
After a push, ask Virgil to refresh the AFFiNE copies. For now that refresh is
|
||||
manual. The current refresh command lives in `docs/projection-operations.md`.
|
||||
|
||||
## Contributor Setup
|
||||
|
||||
Anonymous clone/read works on the lab mesh. Pushing requires a Gitea account or
|
||||
token with write access to `section0/rta-handbook`.
|
||||
Anonymous clone/read works on the private lab network. Pushing requires an
|
||||
account or access token with write access to `section0/rta-handbook`.
|
||||
|
||||
Run this once per checkout:
|
||||
|
||||
@@ -84,8 +89,9 @@ rather than your normal account password.
|
||||
|
||||
## Source Models
|
||||
|
||||
This repo is the Git-backed model: shared docs are canonical in Gitea.
|
||||
This repo is the shared Git model: shared docs are edited in Git, then copied
|
||||
into AFFiNE for reading.
|
||||
|
||||
Personal vault mounts are different: a person keeps custody of their own local
|
||||
Obsidian vault and only projects selected Markdown into AFFiNE. See
|
||||
`docs/source-models.md`.
|
||||
Obsidian vault and only shares selected Markdown into AFFiNE. See
|
||||
`docs/source-models.md` for that more advanced case.
|
||||
|
||||
Reference in New Issue
Block a user