Tate-Wagtail Technical Documentation¶

Project overview¶

Welcome to the Tate Wagtail CMS documentation.

To get your local dev environment up and running, see the README.

External integrations¶

List here any external services this project uses. Preferably link to a separate documentation page for each.

Include any external credentials in the README.

Subscribe to emails: forms in the front-end depend on the Emarsys API to make updates to Tate's database of marketing contacts.
Shop products: the front-end depends on the Salesforce API to fetch details of products from the Tate online shop product catalogue.

Adding documentation¶

All documentation pages are added as markdown files in the docs/ folder in the main repository. If you are new to markdown, there are some useful cheat-sheets online such as this one. The navigation reflects the directory structure. Please maintain numerical order when adding subfolders.

Deploying documentation¶

Docs are deployed to GitHub pages automatically via a GitHub action whenever a branch is merged into main. Docs can also be deployed independently of the development workflow, by running mkdocs gh-deploy, either from the Docker container (NOT currently working, due to the Jinja2 issue), or locally if you have mkdocs installed