|
1 | | -# openarcloud.github.io |
| 1 | +# OpenArCloud Website - Lean Sprint Plan |
| 2 | + |
| 3 | +## 🎯 Mission: Ship in 3-4 Evenings |
| 4 | +Build a clean, modern website that clearly explains OSCP and gets developers to the GitHub repos. That's it. |
| 5 | + |
| 6 | +## ⚡ Tech Stack |
| 7 | +- **11ty** - Dead simple static site generator |
| 8 | +- **GitHub Pages** - Free hosting, zero config |
| 9 | +- **Markdown** - All content in markdown |
| 10 | +- **Minimal CSS** - Maybe Tailwind or just vanilla CSS |
| 11 | +- **No JavaScript** - Unless absolutely needed |
| 12 | + |
| 13 | +## 🗺️ Lean Site Structure (6-8 pages MAX) |
| 14 | + |
| 15 | +``` |
| 16 | +/ |
| 17 | +├── index.md # Homepage - What is OSCP + Get Started |
| 18 | +├── platform.md # OSCP technical overview |
| 19 | +├── github.md # List of repos with descriptions |
| 20 | +├── about.md # Mission + current team |
| 21 | +├── join.md # Link to Patreon + partner info |
| 22 | +└── contact.md # Simple contact info |
| 23 | +``` |
| 24 | + |
| 25 | +## 📝 Page Breakdown |
| 26 | + |
| 27 | +### Homepage (index.md) |
| 28 | +- **Hero**: "Open Spatial Computing Platform" |
| 29 | +- **One-liner**: What OSCP is (30 words max) |
| 30 | +- **Video embed**: If you have a good YouTube video |
| 31 | +- **3 Big CTAs**: |
| 32 | + - → View on GitHub |
| 33 | + - → Read the Docs |
| 34 | + - → Join Community |
| 35 | +- **Partner logos** (if you must) |
| 36 | + |
| 37 | +### Platform (platform.md) |
| 38 | +- **What is OSCP** (2-3 paragraphs) |
| 39 | +- **Core Components** (bullet list): |
| 40 | + - Spatial Service Discovery |
| 41 | + - GeoPose Protocol |
| 42 | + - Spatial Content Discovery |
| 43 | +- **Architecture diagram** (one simple image) |
| 44 | +- **Links to GitHub repos** |
| 45 | + |
| 46 | +### GitHub (github.md) |
| 47 | +- **Quick Start** section |
| 48 | +- **Repository list** with 1-line descriptions: |
| 49 | + - oscp-geopose-protocol - GeoPose implementation |
| 50 | + - oscp-spatial-content-discovery - Content discovery service |
| 51 | + - etc. |
| 52 | +- **Contributing** guidelines (brief) |
| 53 | + |
| 54 | +### About (about.md) |
| 55 | +- **Mission** (2 paragraphs) |
| 56 | +- **Current Leadership** (names + titles only) |
| 57 | +- **Contact info** |
| 58 | + |
| 59 | +### Join (join.md) |
| 60 | +- **Individual Membership** → Link to Patreon |
| 61 | +- **Organizations** → Contact us |
| 62 | +- **Why Join** (3 bullet points) |
| 63 | + |
| 64 | +### Contact (contact.md) |
| 65 | +- Email |
| 66 | +- GitHub org link |
| 67 | +- Maybe a simple form (Formspree or similar) |
| 68 | + |
| 69 | +## 🏃 Sprint Plan |
| 70 | + |
| 71 | +### Evening 1: Setup & Structure |
| 72 | +```bash |
| 73 | +# 1. Initialize 11ty project |
| 74 | +npm init -y |
| 75 | +npm install @11ty/eleventy |
| 76 | + |
| 77 | +# 2. Basic folder structure |
| 78 | +mkdir src src/_includes src/_includes/layouts |
| 79 | + |
| 80 | +# 3. Create base layout |
| 81 | +# 4. Set up GitHub repo |
| 82 | +# 5. Configure GitHub Pages |
| 83 | +``` |
| 84 | + |
| 85 | +### Evening 2: Core Content |
| 86 | +- Write homepage content |
| 87 | +- Write platform overview |
| 88 | +- Create GitHub repos list |
| 89 | +- Add about page |
| 90 | + |
| 91 | +### Evening 3: Design & Polish |
| 92 | +- Basic CSS (responsive, clean) |
| 93 | +- Navigation |
| 94 | +- Footer |
| 95 | +- Test on mobile |
| 96 | +- Deploy to GitHub Pages |
| 97 | + |
| 98 | +### Evening 4: Buffer/Launch |
| 99 | +- Fix any issues |
| 100 | +- Add analytics (if needed) |
| 101 | +- Final review |
| 102 | +- Ship it! |
| 103 | + |
| 104 | +## 📁 Minimal File Structure |
| 105 | + |
| 106 | +``` |
| 107 | +oarc-website/ |
| 108 | +├── src/ |
| 109 | +│ ├── _includes/ |
| 110 | +│ │ └── layouts/ |
| 111 | +│ │ └── base.njk |
| 112 | +│ ├── css/ |
| 113 | +│ │ └── style.css |
| 114 | +│ ├── img/ |
| 115 | +│ │ └── oscp-architecture.png |
| 116 | +│ ├── index.md |
| 117 | +│ ├── platform.md |
| 118 | +│ ├── github.md |
| 119 | +│ ├── about.md |
| 120 | +│ ├── join.md |
| 121 | +│ └── contact.md |
| 122 | +├── .eleventy.js |
| 123 | +├── .gitignore |
| 124 | +├── package.json |
| 125 | +└── README.md |
| 126 | +``` |
| 127 | + |
| 128 | +## 🎨 Design Approach |
| 129 | +- **Font**: System fonts (no Google Fonts) |
| 130 | +- **Colors**: Black, white, one accent color |
| 131 | +- **Layout**: Single column, max-width 800px |
| 132 | +- **Mobile**: Naturally responsive (it's just text) |
| 133 | + |
| 134 | +## ✂️ What We're NOT Doing |
| 135 | +- ❌ Working groups pages |
| 136 | +- ❌ Events/News section |
| 137 | +- ❌ Testbeds |
| 138 | +- ❌ Blog |
| 139 | +- ❌ Complex membership system |
| 140 | +- ❌ Search |
| 141 | +- ❌ Dark mode |
| 142 | +- ❌ Animations |
| 143 | +- ❌ Three.js visualizations |
| 144 | +- ❌ Multiple layouts |
| 145 | +- ❌ Image galleries |
| 146 | + |
| 147 | +## 📋 Quick Start Checklist |
| 148 | + |
| 149 | +### Pre-Sprint |
| 150 | +- [ ] Gather any must-have images (logo, architecture diagram) |
| 151 | +- [ ] Get YouTube video URL if exists |
| 152 | +- [ ] List of GitHub repos to feature |
| 153 | +- [ ] Patreon account setup |
| 154 | + |
| 155 | +### Sprint |
| 156 | +- [ ] Evening 1: Setup complete, test deployment works |
| 157 | +- [ ] Evening 2: All content written and added |
| 158 | +- [ ] Evening 3: Looks good on mobile and desktop |
| 159 | +- [ ] Evening 4: Live on GitHub Pages |
| 160 | + |
| 161 | +## 🚀 11ty Quickstart |
| 162 | + |
| 163 | +```bash |
| 164 | +# Clone and go |
| 165 | +git clone [your-repo] |
| 166 | +cd oarc-website |
| 167 | +npm install |
| 168 | +npm run serve # Local dev |
| 169 | +npm run build # Build for production |
| 170 | +``` |
| 171 | + |
| 172 | +### Minimal .eleventy.js |
| 173 | +```javascript |
| 174 | +module.exports = function(eleventyConfig) { |
| 175 | + eleventyConfig.addPassthroughCopy("src/css"); |
| 176 | + eleventyConfig.addPassthroughCopy("src/img"); |
| 177 | + |
| 178 | + return { |
| 179 | + dir: { |
| 180 | + input: "src", |
| 181 | + output: "_site" |
| 182 | + } |
| 183 | + }; |
| 184 | +}; |
| 185 | +``` |
| 186 | + |
| 187 | +### Minimal package.json scripts |
| 188 | +```json |
| 189 | +{ |
| 190 | + "scripts": { |
| 191 | + "serve": "eleventy --serve", |
| 192 | + "build": "eleventy" |
| 193 | + } |
| 194 | +} |
| 195 | +``` |
| 196 | + |
| 197 | +## 🎯 Success Criteria |
| 198 | +- Loads fast (< 2 seconds) |
| 199 | +- Clear what OSCP is |
| 200 | +- Easy to find GitHub repos |
| 201 | +- Works on mobile |
| 202 | +- Can update content easily |
| 203 | +- Deployed and live |
| 204 | + |
| 205 | +## 💭 Remember |
| 206 | +- Perfect is the enemy of done |
| 207 | +- You can always iterate later |
| 208 | +- Focus on developers finding the GitHub repos |
| 209 | +- Everything else is secondary |
| 210 | + |
| 211 | +--- |
| 212 | + |
| 213 | +**That's it. No more planning. Start coding.** |
0 commit comments