This markdown document contains relevant information on the content management system (CMS), Contentful.
Below are key information regarding setup and usage of the CMS.
Before continuing, please make sure you know/ have already installed the prerequisites for the SML Portal website project, you can build and deploy the site locally. If not you can find instructions on how to do this here: SML Website Project README
Now you will have installed the required packages including the Contentful Python SDK which is required to work with Contentful.
For the Contentful API to work on your local machine, you also need to ensure that you have the API key and space ID defined in your zsh or bash profile.
These are accessible directly through the Contentful website if you have the correct permissions for the space you are working in.
You can access the API key by navigating to Settings > API keys.
If you don't have access to these, you likely don't have the right permissions and should contact the space owner.
Open up your zsh or bash profile in an editor of your choice and define these variables:
ZSH:
export SPACE_ID="your_space_ID"
export CONTENTFUL_ENVIRONMENT="prod"
export CDA_KEY="your_prod_cda_key"BASH:
SPACE_ID="your_space_ID"
CONTENTFUL_ENVIRONMENT="prod"
CDA_KEY="your_prod_cda_key"The prod CDA key can be obtained by asking the admin of your Contentful space.
When developing locally, the CONTENTFUL_ENVIRONMENT variable should be set to "prod" (short for the production environment). The CDA_KEY variable should also be set to the relevant prod CDA key, which can be obtained by asking the admin of your Contentful space. If you want to develop using a different Contentful environment, this will require a different CDA key, and you will need to reassign the CDA_KEY variable in your zsh/bash profile appropriately. You should also change the CONTENTFUL_ENVIRONMENT variable to the corresponding environment name - this should be one of "prod", "preprod", or "dev".
You can find instructions on how to build and deploy the SML Portal website here: SML Website Project README
Now when you navigate to the Contentful web interface, create new content or make any content changes, it should reflect the changes locally on the SML Portal website.
Contentful Overview: Contains guidance on getting started with setting up Contentful, content models, managing content, managing users etc.
Contentful API Reference: Guidance on Content Delivery API (used to retrieve published content to display in your application), Content Management API, Content Preview API and various other APIs.
Contentful Python SDK: This Python SDK client library interacts with the Content Delivery API, a read-only API for retrieving content from Contentful. All content, both JSON and binary, is fetched from the server closest to a user's location using our global CDN.
Python Tutorials/ Demos using Contentful
- This can occur when the owner of the workspace hasn't given you the correct roles and or permissions.
- CDA Key and or Space ID are incorrect in your bash or zsh profile.