You can configure an external content management system such as Contentful.
We have provided some handy import scripts and configuration values to help you import your languages, preview, publish and easily manage all application text, including form fields, labels, validation error messages and SMS messages in multi-language.
Over 1000 different content keys can be content managed.
We currently do not recommend one CMS over another and for now the, process of updating your CMS is outside current OpenCRVS scope. So if you plan on using a CMS, you will need to keep an eye on OpenCRVS releases and perform the necessary migrations when new content keys are added for new features.
An automated commit script in core highlights new keys that need to be imported into your country resources package.
Contentful is a paid-for service but 1 space and 2 locales are free. At the time of writing we couldnt find a better free option for multi-language content management.
When a new commit is pushed to core, you can pass the environment variables RESOURCES_PATH and COUNTRY_CODE and the commit will automatically export content keys in this folder.
To perform an initial import to Contentful:
- First create a space in Contentful and add up to 2 locales for the free plan. Copy your space-id from Contentful settings.
- Download and install the Contentful cli
- Run the following command to export your space as you will need ids for your locales:
contentful space export --space-id=<your-space-id>
- Open the exported file and copy the required ids to this file
- You can run the following command to generate a contentful-import.json file:
- Run the Contentful import script:
contentful space import --content-file src/zmb/features/languages/generated/contentful-import.json --space-id=<your-space-id>
- Get your API key from contentful settings and add it to docker secrets, or paste here for use in development. DO NOT SUBMIT API KEYS TO A PUBLIC REPO!