site updates - still need to fix internal links

This commit is contained in:
2025-05-13 16:35:09 -06:00
parent 196094dbe7
commit 84057b6a9e
45 changed files with 6284 additions and 5152 deletions

View File

@@ -15,10 +15,10 @@
<link rel="canonical" href="http://betteredmonton.org/readme/">
<link rel="prev" href="../quick-commands/">
<link rel="prev" href="..">
<link rel="next" href="../testing/">
<link rel="next" href="../apps/">
<link rel="icon" href="../assets/images/favicon.png">
@@ -26,7 +26,7 @@
<title>Readme - Changemaker Documentation</title>
<title>Get Started - Changemaker Documentation</title>
@@ -65,7 +65,7 @@
<meta property="og:type" content="website" >
<meta property="og:title" content="Readme - Changemaker Documentation" >
<meta property="og:title" content="Get Started - Changemaker Documentation" >
<meta property="og:description" content="Demo site for Changemaker" >
@@ -81,7 +81,7 @@
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Readme - Changemaker Documentation" >
<meta name="twitter:title" content="Get Started - Changemaker Documentation" >
<meta name="twitter:description" content="Demo site for Changemaker" >
@@ -118,7 +118,7 @@
<a href="https://homepage.betteredmonton.org" class="login-button">Login</a>
Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
Changemaker Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
</div>
@@ -151,7 +151,7 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Readme
Get Started
</span>
</div>
@@ -241,6 +241,27 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Get Started
</a>
</li>
@@ -267,7 +288,7 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li class="md-tabs__item">
<a href="../guides/authoring-content/" class="md-tabs__link">
<a href="../guides/" class="md-tabs__link">
@@ -300,46 +321,6 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Readme
</a>
</li>
<li class="md-tabs__item">
<a href="../testing/" class="md-tabs__link">
Testing
</a>
</li>
</ul>
</div>
</nav>
@@ -360,9 +341,7 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Changemaker Documentation" class="md-nav__button md-logo" aria-label="Changemaker Documentation" data-md-component="logo">
@@ -401,12 +380,366 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Get Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Get Started
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#contents" class="md-nav__link">
<span class="md-ellipsis">
Contents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#development-pathway" class="md-nav__link">
<span class="md-ellipsis">
Development Pathway
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start-for-local-dev" class="md-nav__link">
<span class="md-ellipsis">
Quick Start for Local Dev
</span>
</a>
<nav class="md-nav" aria-label="Quick Start for Local Dev">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configure-portainer-immediately" class="md-nav__link">
<span class="md-ellipsis">
⚠️ Configure Portainer Immediately 🦊
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#on-successful-build-vist-local-homepage" class="md-nav__link">
<span class="md-ellipsis">
On Successful Build, Vist Local Homepage
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#local-service-ports" class="md-nav__link">
<span class="md-ellipsis">
Local Service Ports
</span>
</a>
<nav class="md-nav" aria-label="Local Service Ports">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ubuntu-os-build-outs" class="md-nav__link">
<span class="md-ellipsis">
Ubuntu OS &amp; Build Outs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#1-install-docker-and-docker-compose" class="md-nav__link">
<span class="md-ellipsis">
1. Install Docker and Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
2. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-configure-your-environment" class="md-nav__link">
<span class="md-ellipsis">
2. Configure Your Environment
</span>
</a>
<nav class="md-nav" aria-label="2. Configure Your Environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-up-cloudflare-credentials" class="md-nav__link">
<span class="md-ellipsis">
Setting Up Cloudflare Credentials
</span>
</a>
<nav class="md-nav" aria-label="Setting Up Cloudflare Credentials">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-create-an-api-token" class="md-nav__link">
<span class="md-ellipsis">
1. Create an API Token
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-get-your-zone-id" class="md-nav__link">
<span class="md-ellipsis">
2. Get your Zone ID
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-get-your-tunnel-id" class="md-nav__link">
<span class="md-ellipsis">
3. Get your Tunnel ID
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-start-the-services" class="md-nav__link">
<span class="md-ellipsis">
4. Start the Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-cloudflare-tunnel-setup" class="md-nav__link">
<span class="md-ellipsis">
4. Cloudflare Tunnel Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#install-cloudflared-on-ubuntu-2404" class="md-nav__link">
<span class="md-ellipsis">
Install Cloudflared on Ubuntu 24.04
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-your-cloudflare-tunnel" class="md-nav__link">
<span class="md-ellipsis">
Configure Your Cloudflare Tunnel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-a-cloudflare-system-service" class="md-nav__link">
<span class="md-ellipsis">
Create a Cloudflare System Service
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#add-cname-records" class="md-nav__link">
<span class="md-ellipsis">
Add CNAME Records
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#website-build-and-deployment-workflow" class="md-nav__link">
<span class="md-ellipsis">
Website Build and Deployment Workflow
</span>
</a>
<nav class="md-nav" aria-label="Website Build and Deployment Workflow">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#building-your-website" class="md-nav__link">
<span class="md-ellipsis">
Building Your Website
</span>
</a>
<nav class="md-nav" aria-label="Building Your Website">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-using-code-server-recommended-for-remote-deployments" class="md-nav__link">
<span class="md-ellipsis">
Option 1: Using Code Server (recommended for remote deployments)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-locally-on-your-machine" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Locally on your machine
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#development-vs-production" class="md-nav__link">
<span class="md-ellipsis">
Development vs Production
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#accessing-your-services" class="md-nav__link">
<span class="md-ellipsis">
Accessing Your Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -442,8 +775,6 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
@@ -451,11 +782,12 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../apps/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -464,38 +796,23 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Applications
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../apps/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
@@ -859,6 +1176,10 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
@@ -866,8 +1187,6 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
@@ -875,11 +1194,12 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../guides/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -888,17 +1208,25 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -973,48 +1301,18 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Readme
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Readme
</span>
</a>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
@@ -1319,41 +1617,11 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../testing/" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
@@ -1386,7 +1654,6 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li><a href="#create-a-cloudflare-system-service">Create a Cloudflare System Service</a></li>
<li><a href="#add-cname-records">Add CNAME Records</a></li>
<li><a href="#website-build-and-deployment-workflow">Website Build and Deployment Workflow</a></li>
<li><a href="#reset-your-installation">Reset Your Installation</a></li>
<li><a href="#accessing-your-services">Accessing Your Services</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
</ul>
@@ -1426,7 +1693,7 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<li>(Optional) Cloudflare account for tunnel setup</li>
</ul>
<h2 id="quick-start-for-local-dev">Quick Start for Local Dev<a class="headerlink" href="#quick-start-for-local-dev" title="Permanent link">&para;</a></h2>
<p>Review all off the applications <a href="../apps/">here</a></p>
<p>Review all off the applications <a href="apps.md">here</a></p>
<p>If you're familiar with Docker and want to get started quickly:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Clone the repository</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>git<span class="w"> </span>clone<span class="w"> </span>https://gitea.bnkhome.org/bnkops/Changemaker.git
@@ -1817,7 +2084,7 @@ Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.tracking", "navigation.indexes", "navigation.collapse", "toc.integrate", "content.code.copy", "navigation.top", "navigation.tabs"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tracking", "navigation.indexes", "navigation.collapse", "navigation.path", "content.code.copy", "navigation.top", "navigation.tabs"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.13a4f30d.min.js"></script>