dp-zebedee-content

Test content for local development of the dissemination "legacy core" stack. Specifically, this repo generates the directory structure and test content required by zebedee (aka zebedee cms), zebedee reader and the-train.

Getting started

It is strongly recommended that you use a dp-compose stack for your local environment rather than creating one manually. These stacks will complete the following automatically through the stack's provisioning and volume mounts.

If you choose to manually set up an environment then:

1. Clone this repo:

   git clone [email protected]:ONSdigital/dp-zebedee-content

2. Initialise the content

   cd dp-zebedee-content
   make init

3. Set environment variables to configure the appropriate directories for the apps:

   export DP_ZEBEDEE_CONTENT=<PATH TO THIS REPO>
   
   # zebedee cms
   export zebedee_root=${DP_ZEBEDEE_CONTENT}/publishing
   
   # zebedee reader
   export content_dir=${DP_ZEBEDEE_CONTENT}/web/site
   
   # the-train
   export TRANSACTION_STORE=${DP_ZEBEDEE_CONTENT}/web/transactions
   export WEBSITE=${DP_ZEBEDEE_CONTENT}/web/site

Resetting the content

You can delete and recreate your directories and content by re-running:

make init

Adding content

Additional test content can be added by:

1. On a feature branch, copy all files from the directory corresponding to a page on the site to the corresponding location under src/content

2. Re-initialise to test the new content

   make init

3. If the content works as expected then open a PR for the change

Licence

Copyright (c) Crown Copyright (Office for National Statistics)

Test content provided by this repo under contains public sector information sourced from ONS.GOV.UK and licensed under the Open Government Licence v3.0.

Unless stated otherwise, this repo is released under MIT license, see LICENCE for details.