Snowplow Documentation Website (BETA! coming soon)

This website is built using Docusaurus 2, a modern static website generator.

Possible pre-requisites

You might need to install some tools to get this running.

brew install yarn

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Push changes back to your branch and then merge into main branch. The Github Actions will deploy the change across into gh_pages branch that GitHub pages picks up.

Note that when setting up in GitHub, create two branches:

• main - default branch, protected
• gh-pages - protected

Importing from Wordpress

First, initialise the wordpress-export-to-markdown submodule:

pushd wordpress-export-to-markdown
npm install
popd

Next, install some more tools:

pip3 install yq
# on Mac
brew install moreutils
# on Linux use your preferred package manager to install the same

Then export the content from Wordpress (choose “All content”).

Finally, run the import script. WARNING: it will overwrite docs/migrated and docs/reusable!

./import.sh <your-export-file.xml>