Skip to content

brewlet/site

Repository files navigation

Brewlet site and documentation

Deploy website License: MIT

This repository contains the brewlet.sh static website, user-facing documentation, workshop material, and Brewlet branding assets. It contains no runtime, Kubernetes, plugin, specification, or test implementation; those components are independently versioned in the repositories below.

Contents

Path Purpose
index.html, styles.css Static landing page
docs/ User and operator documentation
WORKSHOP.md Hands-on Brewlet workshop
brewlet-logo.svg, brewlet-social.png Brand assets
architecture-*.svg Architecture diagrams
CNAME GitHub Pages custom domain

Related repositories

Local preview

Landing page:

python3 -m http.server 8099

Then open http://localhost:8099.

Documentation site (/docs/ with left navigation):

python3 -m pip install mkdocs mkdocs-material
mkdocs serve

Then open http://localhost:8000/docs/.

Deployment

Pushes to main that change the web assets, documentation, workshop, or Pages workflow build and deploy the static landing page plus a rendered MkDocs site at /docs/.

About

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Contributors