Skip to content

README.md

Latest commit

 

History

History
executable file
·
96 lines (69 loc) · 3.4 KB

README.md

File metadata and controls

executable file
·
96 lines (69 loc) · 3.4 KB
Raw

About Grid

Product documentation for Grid Platform — Git-backed intent, multi-cloud Terraform orchestration, Kubernetes workload GitOps (gated), console, CLI, and install.

Site: https://gridplatform.github.io/doc/
Source of truth: Markdown under docs/ (also readable on GitHub).

License: MIT

Naming

Folders and files follow the same convention as Deep-Dive docs:

  • Folders: Pascal-Case-With-Hyphens (example: Getting-Started, Platform-Ops style)
  • Files: Title_With_Underscores.md (no numeric prefixes)

Read the manual

Section Start here
About Grid Home · Architecture
Getting-Started Quick_Start · Your_Intent_Repository
Concepts Desired_State · Unit_JSON · GitOps_Sync
Clouds One MD per provider, e.g. AWS · GCP
Console Overview
Install Overview · Configuration
Roadmap Roadmap

Install scripts live in grid-core/install — not in this repository.

One-line install (Compose on Ubuntu)

export GRID_AUTH_ADMIN_PASSWORD='choose-a-strong-password'
curl -fsSL https://raw.githubusercontent.com/gridplatform/grid-core/main/install/install.sh | sudo -E bash

Updating configuration tables

Env-var reference tables are generated:

  1. Edit data/configuration.json
  2. Run npm run sync:config
  3. Commit JSON + docs/Install/Configuration.md

CI fails if the generated file is stale.

Cloud catalog pages under docs/Clouds/ are plain Markdown — edit the provider MD file directly (no JSON).

Local docs site

npm ci
npm start          # http://localhost:3000/doc/
npm run build

GitHub Pages is updated by .github/workflows/deploy-pages.yml: it publishes the Docusaurus build/ to gh-pages and points the Pages source at that branch.

Site: https://gridplatform.github.io/doc/

If the site ever shows a plain README again, Pages was switched back to main — re-run Deploy docs or set Settings → Pages → Branch: gh-pages / (root).

Documentation map

docs/
  Home.md
  Roadmap.md
  Architecture/
  Getting-Started/
  Concepts/
  Clouds/          # provider catalog (type/subtype) — one MD each
  Console/
  Admin/
  CLI/
  Install/         # how to install and run Grid
data/
  configuration.json
scripts/
  render-configuration.mjs

Product repositories

Repo Role
grid-core API, GitOps, releases, install
grid-ui Console
grid-cli Generate / plan / apply
grid-terraform Module bank
grid-config Example desired-state tree only

License

MIT