Fix catalog PDF links; add bring-online guide; feature zappier billing
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
PDFs rewrite in-document .md/.html links to sibling PDFs. Catalog start page is GETTING-STARTED (install, first-up, monitor). Billing and user platform is zappier-edge (original ~/zappier tree).
This commit is contained in:
parent
e401635fd6
commit
65bfa544b2
10 changed files with 149 additions and 25 deletions
|
|
@ -21,14 +21,9 @@ SECTIONS = [
|
|||
(
|
||||
"Start here",
|
||||
[
|
||||
("packages/overview/README.md", "System overview (plain language)"),
|
||||
("packages/overview/INDEX.md", "Documentation index"),
|
||||
("packages/verae-ops/README.md", "Install & maintenance (Docker, Proxmox, VMs, metal)"),
|
||||
("packages/verae-fleet/docs/CONSOLE.md", "Operator console (Fleet · Trace · Docs)"),
|
||||
("README.md", "Workspace README"),
|
||||
("docs/04-activate/SETUP-ZAPIER-DEVELOPER.pdf", "Zapier developer setup (PDF)"),
|
||||
("docs/OPEN.md", "Still open"),
|
||||
("TODO.md", "Implementation TODO / gates"),
|
||||
("packages/verae-ops/GETTING-STARTED.md", "Bring the system online (install, first-up, monitor)"),
|
||||
("packages/overview/README.md", "What the system is (plain language)"),
|
||||
("packages/verae-fleet/docs/CONSOLE.md", "Operator console (loopback Fleet · Trace · Docs)"),
|
||||
],
|
||||
),
|
||||
(
|
||||
|
|
@ -52,9 +47,7 @@ SECTIONS = [
|
|||
(
|
||||
"Per-module README (public PDFs)",
|
||||
[
|
||||
("packages/overview/README.md", "overview"),
|
||||
("packages/verae-ops/README.md", "verae-ops (install)"),
|
||||
("packages/zappier/README.md", "zappier-edge"),
|
||||
("packages/zappier/README.md", "zappier-edge (billing + users)"),
|
||||
("packages/verae-zapier-middleware/README.md", "verae-middleware"),
|
||||
("packages/verae-zapier/README.md", "verae-zapier-app"),
|
||||
("packages/verae-activate/README.md", "verae-activate"),
|
||||
|
|
@ -70,25 +63,32 @@ SECTIONS = [
|
|||
],
|
||||
),
|
||||
(
|
||||
"Install / run",
|
||||
"Billing, users, portal (zappier-edge)",
|
||||
[
|
||||
("packages/verae-ops/README.md", "Ops index"),
|
||||
("packages/verae-ops/01-dependencies.md", "Dependencies and data flow"),
|
||||
("packages/zappier/README.md", "zappier-edge README (the billing/user platform)"),
|
||||
("packages/zappier/docs/USER-MANUAL.md", "Operations & usage"),
|
||||
("packages/zappier/docs/USER-MANAGEMENT.md", "Admin users, pricing, customer types"),
|
||||
("packages/zappier/docs/CUSTOMER-PORTAL.md", "Signup, 2FA, API keys, reloads"),
|
||||
("packages/zappier/docs/ACCOUNTING.md", "Invoices, PO billing, reports"),
|
||||
("packages/zappier/docs/DEVELOPER.md", "Developer reference"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"Install (detail)",
|
||||
[
|
||||
("packages/verae-ops/GETTING-STARTED.md", "Bring online (start here)"),
|
||||
("packages/verae-ops/02-docker.md", "Docker Compose"),
|
||||
("packages/verae-ops/03-proxmox.md", "Proxmox LXC / QEMU"),
|
||||
("packages/verae-ops/04-virtual-servers.md", "Virtual servers"),
|
||||
("packages/verae-ops/03-proxmox.md", "Proxmox"),
|
||||
("packages/verae-ops/05-dedicated-hardware.md", "Dedicated hardware"),
|
||||
("packages/verae-ops/06-linking-services.md", "Linking dependent services"),
|
||||
("packages/verae-ops/07-maintenance.md", "Maintenance"),
|
||||
("packages/verae-ops/06-linking-services.md", "Linking services"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"Samples",
|
||||
[
|
||||
("packages/zappier/zapier-app/README.md", "Sample Zapier app (metered zappier API)"),
|
||||
("packages/verae-activate/README.md", "Activate-now Add Numbers sample"),
|
||||
("packages/verae-activate/README.md", "Activate-now Add Numbers"),
|
||||
("packages/verae-zapier-simulator/README.md", "Hop-trace simulator"),
|
||||
("packages/verae-nats-process/README.md", "New NATS address template"),
|
||||
],
|
||||
),
|
||||
(
|
||||
|
|
@ -174,10 +174,11 @@ def render_md(src: Path, html_dest: Path, pdf_dest: Path, title: str) -> str:
|
|||
str(html_dest),
|
||||
"--standalone",
|
||||
f"--resource-path={resource}",
|
||||
"--highlight-style=breezedark",
|
||||
"--syntax-highlighting=breezedark",
|
||||
f"--metadata=title={title}",
|
||||
f"--include-in-header={header}",
|
||||
f"--include-before-body={banner}",
|
||||
f"--lua-filter={ROOT / 'scripts' / 'pdf-links.lua'}",
|
||||
],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
|
|
|
|||
|
|
@ -48,6 +48,7 @@ def main() -> None:
|
|||
"--metadata=title=Verae Time × Zapier — repository READMEs",
|
||||
f"--include-in-header={hdr}",
|
||||
"--syntax-highlighting=breezedark",
|
||||
f"--lua-filter={ROOT / 'scripts' / 'pdf-links.lua'}",
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
|
|
|
|||
19
scripts/pdf-links.lua
Normal file
19
scripts/pdf-links.lua
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
-- Rewrite in-document links so catalog PDFs point at other PDFs, not .md/.html.
|
||||
function Link(el)
|
||||
local t = el.target or ""
|
||||
if t:match("^https?://") and not t:match("zapier%.georgelambert%.org") then
|
||||
return el
|
||||
end
|
||||
if t:match("^mailto:") or t:match("^#") then
|
||||
return el
|
||||
end
|
||||
local path, frag = t:match("^(.-)(#.*)$")
|
||||
if not path then
|
||||
path, frag = t, ""
|
||||
end
|
||||
if path:match("%.md$") or path:match("%.html$") then
|
||||
path = path:gsub("%.md$", ".pdf"):gsub("%.html$", ".pdf")
|
||||
el.target = path .. frag
|
||||
end
|
||||
return el
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue