398 lines
16 KiB
YAML
398 lines
16 KiB
YAML
site_name: Changemaker Lite
|
||
site_description: Build Power. Not Rent It. Own your digital infrastructure.
|
||
site_url: https://bnkserve.org
|
||
site_author: Bunker Operations
|
||
docs_dir: docs
|
||
site_dir: site
|
||
use_directory_urls: true
|
||
|
||
# Repository
|
||
repo_url: https://gitea.bnkops.com/admin/changemaker.lite
|
||
repo_name: changemaker.lite
|
||
edit_uri: src/branch/main/mkdocs/docs
|
||
|
||
# Theme
|
||
theme:
|
||
name: material
|
||
custom_dir: docs/overrides
|
||
logo: assets/logo.png # Commented out until logo exists
|
||
favicon: assets/favicon.png # Commented out until favicon exists
|
||
palette:
|
||
- scheme: slate
|
||
primary: deep purple
|
||
accent: amber
|
||
toggle:
|
||
icon: material/weather-night
|
||
name: Switch to light mode
|
||
- scheme: default
|
||
primary: deep purple
|
||
accent: amber
|
||
toggle:
|
||
icon: material/weather-sunny
|
||
name: Switch to dark mode
|
||
font:
|
||
text: Inter
|
||
code: JetBrains Mono
|
||
features:
|
||
- announce.dismiss
|
||
- content.action.edit
|
||
- content.action.view
|
||
- content.code.annotate
|
||
- content.code.copy
|
||
- content.tooltips
|
||
- navigation.expand
|
||
- navigation.footer
|
||
- navigation.indexes
|
||
# - navigation.instant
|
||
# - navigation.instant.prefetch
|
||
# - navigation.instant.progress
|
||
- navigation.path
|
||
- navigation.prune
|
||
- navigation.sections
|
||
- navigation.tabs
|
||
- navigation.tabs.sticky
|
||
- navigation.top
|
||
- navigation.tracking
|
||
- search.highlight
|
||
- search.share
|
||
- search.suggest
|
||
- toc.follow
|
||
|
||
# Plugins
|
||
plugins:
|
||
- search:
|
||
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
||
- social:
|
||
cards_layout_options:
|
||
background_color: "#5BCEFA"
|
||
color: "#FFFFFF"
|
||
- blog:
|
||
blog_dir: blog
|
||
post_date_format: medium
|
||
archive_name: Archive
|
||
categories_name: Categories
|
||
- tags
|
||
|
||
# Extra CSS and JS
|
||
extra_css:
|
||
- stylesheets/extra.css
|
||
- stylesheets/home.css
|
||
- assets/css/video-player.css
|
||
|
||
extra_javascript:
|
||
- javascripts/home.js
|
||
- javascripts/github-widget.js
|
||
- javascripts/gitea-widget.js
|
||
# env-config.js is auto-generated by hooks/env_config_hook.py
|
||
- assets/js/env-config.js
|
||
- assets/js/video-player.js
|
||
|
||
hooks:
|
||
- docs/hooks/repo_widget_hook.py
|
||
- docs/hooks/env_config_hook.py
|
||
|
||
# Markdown Extensions
|
||
markdown_extensions:
|
||
- abbr
|
||
- admonition
|
||
- attr_list
|
||
- def_list
|
||
- footnotes
|
||
- md_in_html
|
||
- meta
|
||
- toc:
|
||
permalink: true
|
||
title: On this page
|
||
- pymdownx.arithmatex:
|
||
generic: true
|
||
- pymdownx.betterem:
|
||
smart_enable: all
|
||
- pymdownx.caret
|
||
- pymdownx.details
|
||
- pymdownx.emoji:
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
- pymdownx.highlight:
|
||
anchor_linenums: true
|
||
line_spans: __span
|
||
pygments_lang_class: true
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.keys
|
||
- pymdownx.mark
|
||
- pymdownx.smartsymbols
|
||
- pymdownx.snippets
|
||
- pymdownx.superfences:
|
||
custom_fences:
|
||
- name: mermaid
|
||
class: mermaid
|
||
format: !!python/name:pymdownx.superfences.fence_code_format
|
||
- pymdownx.tabbed:
|
||
alternate_style: true
|
||
combine_header_slug: true
|
||
- pymdownx.tasklist:
|
||
custom_checkbox: true
|
||
- pymdownx.tilde
|
||
|
||
# Extra configuration
|
||
extra:
|
||
generator: false
|
||
social:
|
||
- icon: fontawesome/brands/github
|
||
link: https://gitea.bnkops.com/admin
|
||
name: Gitea Repository
|
||
- icon: fontawesome/solid/paper-plane
|
||
link: https://listmonk.bnkops.com/subscription/form
|
||
name: Newsletter
|
||
|
||
# Copyright
|
||
copyright: >
|
||
Copyright © 2024 The Bunker Operations –
|
||
<a href="#__consent">Change cookie settings</a>
|
||
|
||
# Navigation
|
||
nav:
|
||
- Home: index.md
|
||
- V2 Documentation:
|
||
- v2/index.md
|
||
- Getting Started:
|
||
- v2/getting-started/index.md
|
||
- Quick Start: v2/getting-started/quick-start.md
|
||
- Architecture:
|
||
- v2/architecture/index.md
|
||
- Dual API System: v2/architecture/dual-api.md
|
||
- Authentication & Security: v2/architecture/authentication.md
|
||
- Backend:
|
||
- v2/backend/index.md
|
||
- Modules:
|
||
- v2/backend/modules/index.md
|
||
- Auth Module: v2/backend/modules/auth.md
|
||
- Users Module: v2/backend/modules/users.md
|
||
- Settings Module: v2/backend/modules/settings.md
|
||
- Campaigns Module: v2/backend/modules/campaigns.md
|
||
- Representatives Module: v2/backend/modules/representatives.md
|
||
- Responses Module: v2/backend/modules/responses.md
|
||
- Locations Module: v2/backend/modules/locations.md
|
||
- Shifts Module: v2/backend/modules/shifts.md
|
||
- Canvass Module: v2/backend/modules/canvass.md
|
||
- Pages Module: v2/backend/modules/pages.md
|
||
- Media Module: v2/backend/modules/media.md
|
||
- Services:
|
||
- v2/backend/services/index.md
|
||
- Middleware:
|
||
- v2/backend/middleware/index.md
|
||
- Utilities:
|
||
- v2/backend/utilities/index.md
|
||
- Frontend:
|
||
- v2/frontend/index.md
|
||
- Components:
|
||
- v2/frontend/components/index.md
|
||
- Layouts:
|
||
- v2/frontend/layouts/index.md
|
||
- Pages:
|
||
- v2/frontend/pages/index.md
|
||
- Admin Pages:
|
||
- v2/frontend/pages/admin/index.md
|
||
- Dashboard: v2/frontend/pages/admin/dashboard-page.md
|
||
- Users: v2/frontend/pages/admin/users-page.md
|
||
- Settings: v2/frontend/pages/admin/settings-page.md
|
||
- Campaigns: v2/frontend/pages/admin/campaigns-page.md
|
||
- Representatives: v2/frontend/pages/admin/representatives-page.md
|
||
- Responses: v2/frontend/pages/admin/responses-page.md
|
||
- Email Queue: v2/frontend/pages/admin/email-queue-page.md
|
||
- Locations: v2/frontend/pages/admin/locations-page.md
|
||
- Cuts: v2/frontend/pages/admin/cuts-page.md
|
||
- Shifts: v2/frontend/pages/admin/shifts-page.md
|
||
- Map Settings: v2/frontend/pages/admin/map-settings-page.md
|
||
- Canvass Dashboard: v2/frontend/pages/admin/canvass-dashboard-page.md
|
||
- Walk Sheet: v2/frontend/pages/admin/walk-sheet-page.md
|
||
- Cut Export: v2/frontend/pages/admin/cut-export-page.md
|
||
- Data Quality Dashboard: v2/frontend/pages/admin/data-quality-dashboard-page.md
|
||
- Landing Pages: v2/frontend/pages/admin/landing-pages-page.md
|
||
- Page Editor: v2/frontend/pages/admin/page-editor-page.md
|
||
- Email Templates: v2/frontend/pages/admin/email-templates-page.md
|
||
- Email Template Editor: v2/frontend/pages/admin/email-template-editor-page.md
|
||
- Listmonk: v2/frontend/pages/admin/listmonk-page.md
|
||
- Pangolin: v2/frontend/pages/admin/pangolin-page.md
|
||
- Docs: v2/frontend/pages/admin/docs-page.md
|
||
- MkDocs Settings: v2/frontend/pages/admin/mkdocs-settings-page.md
|
||
- Observability: v2/frontend/pages/admin/observability-page.md
|
||
- Mini QR: v2/frontend/pages/admin/mini-qr-page.md
|
||
- MailHog: v2/frontend/pages/admin/mailhog-page.md
|
||
- Code Editor: v2/frontend/pages/admin/code-editor-page.md
|
||
- NocoDB: v2/frontend/pages/admin/nocodb-page.md
|
||
- n8n: v2/frontend/pages/admin/n8n-page.md
|
||
- Gitea: v2/frontend/pages/admin/gitea-page.md
|
||
- Public Pages:
|
||
- v2/frontend/pages/public/index.md
|
||
- Campaigns List: v2/frontend/pages/public/campaigns-list-page.md
|
||
- Campaign Detail: v2/frontend/pages/public/campaign-page.md
|
||
- Response Wall: v2/frontend/pages/public/response-wall-page.md
|
||
- Map: v2/frontend/pages/public/map-page.md
|
||
- Shifts: v2/frontend/pages/public/shifts-page.md
|
||
- Landing Page: v2/frontend/pages/public/landing-page.md
|
||
- Media Gallery: v2/frontend/pages/public/media-gallery-page.md
|
||
- Media Viewer: v2/frontend/pages/public/media-viewer-page.md
|
||
- Volunteer Pages:
|
||
- v2/frontend/pages/volunteer/index.md
|
||
- Volunteer Shifts: v2/frontend/pages/volunteer/volunteer-shifts-page.md
|
||
- Volunteer Map: v2/frontend/pages/volunteer/volunteer-map-page.md
|
||
- My Activity: v2/frontend/pages/volunteer/my-activity-page.md
|
||
- My Routes: v2/frontend/pages/volunteer/my-routes-page.md
|
||
- Database:
|
||
- v2/database/index.md
|
||
- Schema Overview: v2/database/schema.md
|
||
- Migrations: v2/database/migrations.md
|
||
- Seeding: v2/database/seeding.md
|
||
- Indexes: v2/database/indexes.md
|
||
- Models:
|
||
- v2/database/models/index.md
|
||
- Auth Models: v2/database/models/auth.md
|
||
- Settings Models: v2/database/models/settings.md
|
||
- Influence Models: v2/database/models/influence.md
|
||
- Map Models: v2/database/models/map.md
|
||
- Canvass Models: v2/database/models/canvass.md
|
||
- Pages Models: v2/database/models/pages.md
|
||
- Email Templates Models: v2/database/models/email-templates.md
|
||
- Media Models: v2/database/models/media.md
|
||
- Features:
|
||
- v2/features/index.md
|
||
- Influence:
|
||
- v2/features/influence/index.md
|
||
- Campaigns: v2/features/influence/campaigns.md
|
||
- Representatives: v2/features/influence/representatives.md
|
||
- Postal Codes: v2/features/influence/postal-codes.md
|
||
- Responses: v2/features/influence/responses.md
|
||
- Email Queue: v2/features/influence/email-queue.md
|
||
- Map:
|
||
- v2/features/map/index.md
|
||
- Locations: v2/features/map/locations.md
|
||
- Geocoding: v2/features/map/geocoding.md
|
||
- Cuts: v2/features/map/cuts.md
|
||
- Shifts: v2/features/map/shifts.md
|
||
- Canvassing: v2/features/map/canvassing.md
|
||
- Tracking: v2/features/map/tracking.md
|
||
- Walk Sheets: v2/features/map/walk-sheets.md
|
||
- NAR Import: v2/features/map/nar-import.md
|
||
- Data Quality: v2/features/map/data-quality.md
|
||
- Landing Pages:
|
||
- v2/features/landing-pages/index.md
|
||
- Page Builder: v2/features/pages/page-builder.md
|
||
- GrapesJS Editor: v2/features/pages/grapes-editor.md
|
||
- Block Library: v2/features/pages/block-library.md
|
||
- MkDocs Export: v2/features/pages/mkdocs-export.md
|
||
- Email Templates:
|
||
- v2/features/email-templates/index.md
|
||
- Template System: v2/features/email-templates/template-system.md
|
||
- Editor: v2/features/email-templates/editor.md
|
||
- Variables: v2/features/email-templates/variables.md
|
||
- Versioning: v2/features/email-templates/versioning.md
|
||
- Media:
|
||
- v2/features/media/index.md
|
||
- Video Library: v2/features/media/video-library.md
|
||
- Upload System: v2/features/media/upload.md
|
||
- Public Gallery: v2/features/media/public-gallery.md
|
||
- Jobs: v2/features/media/jobs.md
|
||
- Newsletter:
|
||
- v2/features/newsletter/index.md
|
||
- Observability:
|
||
- v2/features/observability/index.md
|
||
- Tunnel:
|
||
- v2/features/tunnel/index.md
|
||
- Deployment:
|
||
- v2/deployment/index.md
|
||
- Docker Compose: v2/deployment/docker-compose.md
|
||
- Environment Variables: v2/deployment/environment-variables.md
|
||
- Nginx Configuration: v2/deployment/nginx.md
|
||
- SSL/TLS: v2/deployment/ssl-tls.md
|
||
- Tunneling: v2/deployment/tunneling.md
|
||
- Monitoring Stack: v2/deployment/monitoring-stack.md
|
||
- Health Checks: v2/deployment/healthchecks.md
|
||
- Scaling: v2/deployment/scaling.md
|
||
- Backup & Restore: v2/deployment/backup-restore.md
|
||
- Development:
|
||
- v2/development/index.md
|
||
- Local Setup: v2/development/local-setup.md
|
||
- Docker Workflow: v2/development/docker-workflow.md
|
||
- Git Workflow: v2/development/git-workflow.md
|
||
- NPM Commands: v2/development/npm-commands.md
|
||
- Migrations: v2/development/migrations.md
|
||
- TypeScript: v2/development/typescript.md
|
||
- Testing: v2/development/testing.md
|
||
- Debugging: v2/development/debugging.md
|
||
- Code Style: v2/development/code-style.md
|
||
- API Reference:
|
||
- v2/api-reference/index.md
|
||
- User Guides:
|
||
- v2/user-guides/index.md
|
||
- Admin Guide: v2/user-guides/admin-guide.md
|
||
- Campaign Manager Guide: v2/user-guides/campaign-manager-guide.md
|
||
- Map Organizer Guide: v2/user-guides/map-organizer-guide.md
|
||
- Content Editor Guide: v2/user-guides/content-editor-guide.md
|
||
- Volunteer Guide: v2/user-guides/volunteer-guide.md
|
||
- Troubleshooting:
|
||
- v2/troubleshooting/index.md
|
||
- FAQ: v2/troubleshooting/faq.md
|
||
- Common Errors: v2/troubleshooting/common-errors.md
|
||
- Auth Issues: v2/troubleshooting/auth-issues.md
|
||
- Database Issues: v2/troubleshooting/database-issues.md
|
||
- Docker Issues: v2/troubleshooting/docker-issues.md
|
||
- Email Issues: v2/troubleshooting/email-issues.md
|
||
- Geocoding Issues: v2/troubleshooting/geocoding-issues.md
|
||
- Monitoring Issues: v2/troubleshooting/monitoring-issues.md
|
||
- Performance Optimization: v2/troubleshooting/performance-optimization.md
|
||
- Migration:
|
||
- v2/migration/index.md
|
||
- Feature Parity: v2/migration/feature-parity.md
|
||
- Breaking Changes: v2/migration/breaking-changes.md
|
||
- API Changes: v2/migration/api-changes.md
|
||
- Data Migration: v2/migration/data-migration.md
|
||
- Contributing:
|
||
- v2/contributing/index.md
|
||
- Development Setup: v2/contributing/development-setup.md
|
||
- Code of Conduct: v2/contributing/code-of-conduct.md
|
||
- Pull Requests: v2/contributing/pull-requests.md
|
||
- Roadmap: v2/contributing/roadmap.md
|
||
- Philosophy:
|
||
- phil/index.md
|
||
- Who Reads Your Secrets: https://docs.bnkops.com/archive/repo.archive/thatreallyblondehuman/Thoughts%20%F0%9F%A4%94/If%20you%20do%20politics%20who%20is%20reading%20your%20secrets%20-%20why%20you%20should%20de-corp%20your%20software%20stack/
|
||
- How To Not Get Got Making Content: https://docs.bnkops.com/archive/repo.archive/thatreallyblondehuman/Thoughts%20%F0%9F%A4%94/How%20not%20to%20get%20got%20making%20content%20v2/
|
||
- Digital Organizing: https://docs.bnkops.com/archive/repo.archive/thatreallyblondehuman/Thoughts%20%F0%9F%A4%94/Distributed%20Digital%20Organizing%20is%20The%20Way%20Out/
|
||
- What is Security Culture: https://docs.bnkops.com/archive/repo.archive/Zines%20We%20Like%20%F0%9F%98%8E/What%20Is%20Security%20Culture%20%E2%98%A0/#what-is-security-culture
|
||
- Cost Comparison: phil/cost-comparison.md
|
||
- V1 Documentation (Legacy):
|
||
- v1/index.md
|
||
- Build Guides:
|
||
- v1/build/index.md
|
||
- Build Server: v1/build/server.md
|
||
- Build Map: v1/build/map.md
|
||
- Build Influence: v1/build/influence.md
|
||
- Build Site: v1/build/site.md
|
||
- Services:
|
||
- v1/services/index.md
|
||
- Homepage: v1/services/homepage.md
|
||
- Code Server: v1/services/code-server.md
|
||
- MKDocs: v1/services/mkdocs.md
|
||
- Static Server: v1/services/static-server.md
|
||
- Listmonk: v1/services/listmonk.md
|
||
- PostgreSQL: v1/services/postgresql.md
|
||
- n8n: v1/services/n8n.md
|
||
- NocoDB: v1/services/nocodb.md
|
||
- Gitea: v1/services/gitea.md
|
||
- Map: v1/services/map.md
|
||
- Mini QR: v1/services/mini-qr.md
|
||
- Configuration:
|
||
- v1/config/index.md
|
||
- Cloudflare: v1/config/cloudflare-config.md
|
||
- MKdocs: v1/config/mkdocs.md
|
||
- Code Server: v1/config/coder.md
|
||
- Map: v1/config/map.md
|
||
- Manuals:
|
||
- v1/manual/index.md
|
||
- Map: v1/manual/map.md
|
||
- Advanced Configuration:
|
||
- v1/adv/index.md
|
||
- SSH + Tailscale + Ansible: v1/adv/ansible.md
|
||
- SSH + VScode: v1/adv/vscode-ssh.md
|
||
- Blog:
|
||
- blog/index.md
|