Clarify Section 0 setup language
This commit is contained in:
@@ -5,7 +5,7 @@ PROJECTOR_DIR="${PROJECTOR_DIR:-/Users/virgil/Developer/rta/tmp/markdown-project
|
||||
HOME_LAB_DIR="${HOME_LAB_DIR:-/Users/virgil/Developer/Virgil-Info/home-lab-v7}"
|
||||
|
||||
if [ ! -d "$PROJECTOR_DIR/.git" ]; then
|
||||
echo "Projector checkout not found: $PROJECTOR_DIR" >&2
|
||||
echo "Sync checkout not found: $PROJECTOR_DIR" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
@@ -14,17 +14,17 @@ if [ ! -d "$HOME_LAB_DIR" ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "==> Pulling projector checkout"
|
||||
echo "==> Pulling the Git docs checkout"
|
||||
git -C "$PROJECTOR_DIR" pull --ff-only
|
||||
|
||||
echo "==> Checking projector checkout is clean"
|
||||
echo "==> Checking the Git docs checkout is clean"
|
||||
if [ -n "$(git -C "$PROJECTOR_DIR" status --porcelain)" ]; then
|
||||
git -C "$PROJECTOR_DIR" status --short
|
||||
echo "Projector checkout is dirty; projection must read a clean source." >&2
|
||||
echo "Git docs checkout is dirty; refresh must read a clean source." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "==> Projecting Markdown into AFFiNE"
|
||||
echo "==> Refreshing AFFiNE from Markdown"
|
||||
cd "$HOME_LAB_DIR"
|
||||
nix develop --command bash -lc "scripts/ops/sync-obsidian-affine.rb \
|
||||
--name section0-rta-handbook \
|
||||
|
||||
@@ -40,7 +40,7 @@ REPO_DIR="$TARGET_DIR"
|
||||
|
||||
usage() {
|
||||
cat <<USAGE
|
||||
section0-docs - helper for Section 0 Git Projection repos
|
||||
section0-docs - helper for Section 0 shared Markdown docs
|
||||
|
||||
Commands:
|
||||
configure set Git author name/email for this repo
|
||||
@@ -62,8 +62,8 @@ Examples:
|
||||
MESSAGE="Update concept notes" section0-docs commit
|
||||
section0-docs push
|
||||
|
||||
AFFiNE is read-only for this repo. Durable edits happen in Markdown, then the
|
||||
projection operator pulls and projects.
|
||||
AFFiNE is read-only for these docs. Make lasting changes in Markdown; the
|
||||
AFFiNE copies are refreshed from Git.
|
||||
USAGE
|
||||
}
|
||||
|
||||
@@ -157,7 +157,7 @@ Contributor setup:
|
||||
$COMMAND_NAME configure
|
||||
$COMMAND_NAME push-test
|
||||
|
||||
AFFiNE updates after the projection operator pulls and runs projection.
|
||||
AFFiNE updates after the Markdown docs are refreshed from Git.
|
||||
|
||||
If $COMMAND_DIR is not on PATH, add this to your shell profile:
|
||||
export PATH="$COMMAND_DIR:\$PATH"
|
||||
|
||||
Reference in New Issue
Block a user