From c8f1aac8cc54e49602bcce056b16d1c600d17149 Mon Sep 17 00:00:00 2001 From: smartupzeroadmin Date: Fri, 4 Jul 2025 22:03:44 +0000 Subject: [PATCH] Add From 0 --- From-0.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 From-0.md diff --git a/From-0.md b/From-0.md new file mode 100644 index 0000000..a253606 --- /dev/null +++ b/From-0.md @@ -0,0 +1,106 @@ +july 4 2025 + + +##: What We’re Setting Up – `0_timeline` + +The `0_timeline` is the **public-facing layer of the Smartup** — a static website auto-generated from the internal Forgejo repo structure. It brings **transparency** and **momentum** to the project. + +--- +what is it?? + +This project is a simple static site built with MkDocs and Material theme, deployed on Clever Cloud using a lightweight Python HTTP server. The setup is minimal and straightforward, relying on Python virtual environments and Clever Cloud’s deployment hooks. + +### 🔍 Purpose + +#### 1. **Transparency** + +Let the outside world monitor: + +* What we’re building +* Why we’re building it +* Who’s involved + +#### 2. **Recruitment** + +Help new contributors: + +* See open roles and get involved +* Understand governance, credits, and roadmap +* Follow live progress (issue milestones, bounties, completed tasks) + + +### 🧱 Architecture Goals + +| Feature | Description | +| ------------------------ | ---------------------------------------------------------------------- | +| **Auto-generated** | Site built directly from Forgejo repo structure — no duplicate content | +| **Readable** | Clear, accessible UX for outsiders and first-time visitors | +| **Live & Synced** | Always reflects current status of governance, code, funding | +| **Static & Lightweight** | No backend, served from Clever Cloud or similar (HTML + JS bundle) | + +--- + +### 📦 Content Sources + +The site will pull structured content from: + +* `README.md` / `SUMMARY.md` from `docs/` +* Issues and Milestones in `forgejo` repos +* Ledger and Credit updates from `smartup-credit` +* Roles and contributor list from `governance/` repo +* Public-facing objectives (like this brief) from `0_timeline.org` itself + +--- + +### 🛠 Tech Stack (Proposed) + +| Component | Tool | +| --------------------- | ------------------------------------------- | +| Static Site Generator | `mkdocs` | +| Theme | `mkdocs-material` | +| Nav generation | `awesome-pages` plugin | +| Git-based metadata | `git-revision-date-localized-plugin` | +| Remote content | `mkdocs-monorepo-plugin` or symlinks | +| Deployment | Docker → Clever Cloud | +| Search | Built-in (lunr.js), works offline | +| Styling | Comes with great defaults (Material UI) | + +* +--- + +### ⏱ What We Did Today + +1. **Set up project folder** `1_general_forum` with `docs/` and `mkdocs.yml`. +2. Created a Python virtual environment (`venv`) and activated it. +3. Installed MkDocs Material theme and plugins. +4. Created `docs/index.md` with sample content. +5. Configured `mkdocs.yml` for site name, theme, nav, and plugins. +6. Tested the site locally with `mkdocs serve` — site displayed correctly. +7. Generated `requirements.txt` with `pip freeze`. +8. Created Clever Cloud config file `.clevercloud/python.json` specifying: + - Python 3.11 runtime + - Build command: `pip install -r requirements.txt` + - Start command: `mkdocs build && python -m http.server --directory site $PORT` +9. Initialized git repo and pushed to Clever Cloud for deployment. + +## Debugging and Current Status + +- Deployment on Clever Cloud **fails to start properly**. +- Verified Python 3.13 is used, config file is present. +- Checked build logs: no obvious package errors, but the server does not serve site as expected. +- Confirmed that `mkdocs build` generates `site/` folder locally. +- Start command uses `python -m http.server --directory site $PORT` — unsure if Clever Cloud correctly passes `$PORT` or if `http.server` works as intended. +- Domain `timeline0.org` DNS settings not verified yet due to deployment issues. + +## Where We Are Stuck + +- The app does not deploy and serve correctly on Clever Cloud. +- Need to confirm: + - Correct Python version compatibility. + - Correct start command syntax (especially `$PORT` usage). + - That the built static files exist and are accessible on the server. +- Need further debugging with Clever Cloud logs and possibly adjusting deployment config. + +--- + +