Website for SQLFluff.
The shared visual system for the main site, documentation, and statistics site is described in DESIGN_PLAN.md.
- Built with Hugo.
- Uses the shared design package vendored as a Git submodule at
vendor/sqlfluff-design. Other consumers should follow its integration guide. - Deployed with Netlify. We're also signed up to an Open Source plan with Netlify, which requires us to credit them in the site footer.
- Favicons generated with https://favicon.io/.
This repository is public so that hosting is free. Write access is however locked down to a small number of people. Contributions are still very welcome. Please raise issues and PRs for anything you normally would.
You'll need to install hugo locally. See https://gohugo.io/installation/.
Clone with git clone --recurse-submodules, or after cloning run
git submodule update --init to fetch the shared design assets.
After installation, run hugo server for local development.
Articles live in content/updates/<slug>/index.md. See
publicity/README.md for drafting, review, publication and
the proposed social copy accompanying each article.
Run hugo server --buildDrafts to preview unpublished articles. Netlify deploy
previews and branch deploys also include drafts and request that search engines
do not index them. These previews are publicly accessible, so draft content must
not contain confidential information. Production builds exclude drafts.
- Hugo is released under the Apache License.