Default the public catalog to colored PDFs
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Render published markdown with pandoc + WeasyPrint (indigo tables, dark code). Home page links to PDFs with a top-right switch to Markdown indexes. Serve CONSOLE.pdf from the operator console.
This commit is contained in:
parent
cf4ef9e3af
commit
5ad3222def
9 changed files with 957 additions and 182 deletions
|
|
@ -1,8 +1,8 @@
|
|||
# Documentation index
|
||||
|
||||
Read **high-level first**, then **architecture**, then the rest. Live catalog: https://zapier.georgelambert.org/
|
||||
Read **high-level first**, then **architecture**, then the rest. Live catalog (PDF by default): https://zapier.georgelambert.org/ — [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
|
||||
Operator console (loopback): http://127.0.0.1:3850/
|
||||
Operator console (loopback): http://127.0.0.1:3850/ · [CONSOLE.pdf](https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf)
|
||||
|
||||
## 1. High-level (non-technical)
|
||||
|
||||
|
|
@ -24,25 +24,25 @@ Operator console (loopback): http://127.0.0.1:3850/
|
|||
| Address routing | [06-address-routing.md](06-address-routing.md) |
|
||||
| External resources | [07-external-resources.md](07-external-resources.md) |
|
||||
| Diagrams | [08-diagrams.md](08-diagrams.md) |
|
||||
| Catalog home | https://zapier.georgelambert.org/ |
|
||||
| Composition | https://zapier.georgelambert.org/docs/02-architecture/composition.html |
|
||||
| NATS gateway | https://zapier.georgelambert.org/docs/02-architecture/nats-gateway.html |
|
||||
| NATS subjects | https://zapier.georgelambert.org/docs/02-architecture/nats-subjects.html |
|
||||
| Archive / bloom | https://zapier.georgelambert.org/docs/02-architecture/archive-nats.html |
|
||||
| Module NATS map | https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.html |
|
||||
| Tree nodes | https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.html |
|
||||
| Fleet | https://zapier.georgelambert.org/docs/02-architecture/fleet.html |
|
||||
| Catalog home | https://zapier.georgelambert.org/ (PDF) · [Markdown indexes](https://zapier.georgelambert.org/index-md.html) |
|
||||
| Composition | https://zapier.georgelambert.org/docs/02-architecture/composition.pdf |
|
||||
| NATS gateway | https://zapier.georgelambert.org/docs/02-architecture/nats-gateway.pdf |
|
||||
| NATS subjects | https://zapier.georgelambert.org/docs/02-architecture/nats-subjects.pdf |
|
||||
| Archive / bloom | https://zapier.georgelambert.org/docs/02-architecture/archive-nats.pdf |
|
||||
| Module NATS map | https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.pdf |
|
||||
| Tree nodes | https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.pdf |
|
||||
| Fleet | https://zapier.georgelambert.org/docs/02-architecture/fleet.pdf |
|
||||
|
||||
## 3. Remaining documentation
|
||||
|
||||
| Document | URL |
|
||||
|----------|-----|
|
||||
| Expansion template | [09-expansion-template.md](09-expansion-template.md) |
|
||||
| Operator console | https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md |
|
||||
| User guide | https://zapier.georgelambert.org/user-docs/README.md |
|
||||
| Tree-node lookup (users) | https://zapier.georgelambert.org/packages/zapier-user-docs/09-lookup-tree-nodes.html |
|
||||
| Zapier developer setup | https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.html |
|
||||
| docs-master | https://zapier.georgelambert.org/docs-master/README.md |
|
||||
| Operator console | https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf |
|
||||
| User guide | https://zapier.georgelambert.org/user-docs/README.pdf |
|
||||
| Tree-node lookup (users) | https://zapier.georgelambert.org/packages/zapier-user-docs/09-lookup-tree-nodes.pdf |
|
||||
| Zapier developer setup | https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.pdf |
|
||||
| docs-master | https://zapier.georgelambert.org/docs-master/README.pdf |
|
||||
|
||||
## Independent git repositories
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
High-level description of the whole system: what it is, which **independent git repositories** implement it, how it stays up, how it behaves when the local network fails, and how it talks to the **central Verae NATS.IO 3-server cluster**. New work is added by **new address routing**, not by teaching Zapier about NATS.
|
||||
|
||||
**This repo:** https://git.georgelambert.org/marchon/overview
|
||||
**Live catalog:** https://zapier.georgelambert.org/
|
||||
**Live catalog (PDF by default):** https://zapier.georgelambert.org/ · [Markdown indexes](https://zapier.georgelambert.org/index-md.html)
|
||||
**Clone:** `ssh://git@git.georgelambert.org:2223/marchon/overview.git`
|
||||
|
||||
## Table of contents
|
||||
|
|
@ -49,7 +49,7 @@ Clone any of them: `git clone ssh://git@git.georgelambert.org:2223/marchon/<name
|
|||
|
||||
## Operator console (loopback)
|
||||
|
||||
Fleet, message **Trace**, and **Docs** share one shell at http://127.0.0.1:3850/ (`verae-fleet`). Not public. See [verae-fleet CONSOLE.md](https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md).
|
||||
Fleet, message **Trace**, and **Docs** share one shell at http://127.0.0.1:3850/ (`verae-fleet`). Not public. See [CONSOLE.pdf](https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf).
|
||||
|
||||
|
||||
|
||||
|
|
@ -80,11 +80,11 @@ Start at the top. Architecture is second. Everything else is reference.
|
|||
| [Address routing](06-address-routing.md) | Unplanned functions as new subjects |
|
||||
| [External resources](07-external-resources.md) | Chain, WORM, tree-node search |
|
||||
| [Diagrams](08-diagrams.md) | SVG + mermaid |
|
||||
| [Fleet](https://zapier.georgelambert.org/docs/02-architecture/fleet.html) | Operator replica control |
|
||||
| [Module NATS map](https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.html) | Address table |
|
||||
| [Archive / bloom](https://zapier.georgelambert.org/docs/02-architecture/archive-nats.html) | Multipart and multi-receipt |
|
||||
| [Tree nodes](https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.html) | Bulk Merkle leaves |
|
||||
| [Composition](https://zapier.georgelambert.org/docs/02-architecture/composition.html) | zappier + middleware HTTPS |
|
||||
| [Fleet](https://zapier.georgelambert.org/docs/02-architecture/fleet.pdf) | Operator replica control |
|
||||
| [Module NATS map](https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.pdf) | Address table |
|
||||
| [Archive / bloom](https://zapier.georgelambert.org/docs/02-architecture/archive-nats.pdf) | Multipart and multi-receipt |
|
||||
| [Tree nodes](https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.pdf) | Bulk Merkle leaves |
|
||||
| [Composition](https://zapier.georgelambert.org/docs/02-architecture/composition.pdf) | zappier + middleware HTTPS |
|
||||
|
||||
### 3. Remaining documentation
|
||||
|
||||
|
|
@ -92,10 +92,10 @@ Start at the top. Architecture is second. Everything else is reference.
|
|||
|----------|------------|
|
||||
| [Documentation index](INDEX.md) | A–Z and catalog URLs |
|
||||
| [Expansion template](09-expansion-template.md) / [verae-nats-process](https://git.georgelambert.org/marchon/verae-nats-process) | Copy this to add an address |
|
||||
| [Operator console](https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md) | Screenshots of Fleet / Trace / Docs |
|
||||
| [Operator console](https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf) | Screenshots of Fleet / Trace / Docs |
|
||||
| [Simulator](https://git.georgelambert.org/marchon/verae-zapier-simulator) | Standalone trace (also inside the console) |
|
||||
| [Zapier developer setup](https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.html) | CLI / login / push |
|
||||
| Live catalog | https://zapier.georgelambert.org/ |
|
||||
| [Zapier developer setup](https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.pdf) | CLI / login / push |
|
||||
| Live catalog | https://zapier.georgelambert.org/ (PDF) · [Markdown indexes](https://zapier.georgelambert.org/index-md.html) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue