Skip navigation

Setting Up a New Site

Setting Up a New Site

Create a new Sparrow CMS site from scratch.

1. Scaffold

Copy an existing site directory (e.g. sparrow-cerych) as your template. Update .env with your image name and tag. Update config/settings/base.py with your language and apps.

2. Models

Define page types in website/models.py. At minimum you need WebPage, ArticlePage, and ArticleIndexPage.

3. Theme

Pick a Bootswatch theme in scss/default.scss. Override variables in _variables.scss. Compile with python manage.py sass.

4. Import

Create YAML import files in docker/import/ for locales, root page, site config, header, and footer. Run python manage.py import_pages.

5. Deploy

Build the Docker image with just publish-image. Push to registry. Update the deployment inventory and deploy via ArgoCD.