This repository contains the code for two charms:
content-cache: A machine charm managing a nginx instance configured as a content cache. See the content-cache README for more information.content-cache-backends-config: A subordinate charm providing the configuration required to expose a set of backend services. See the content-cache-backends-config README for more information.
Our documentation is stored in the docs directory.
It is based on the Canonical starter pack
and hosted on Read the Docs. In structuring,
the documentation employs the Diátaxis approach.
You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.
To run the documentation locally before submitting your changes:
cd docs
make runGitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.
You can (and should) run the same checks locally:
make spelling
make linkcheck
make vale
make lint-mdThe Content Cache Project is a member of the Ubuntu family. It is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.