This is a single location for all technical/developer documentation for product teams working on the Private Cloud OpenShift Platform.
Visit the deployed Gatsby site at beta-docs.developer.gov.bc.ca.
Markdown documents are located in ./src/docs
with related images in ./src/images
.
Please see Writing guide for Platform Services technical documentation for documentation formatting and contribution information.
A Gatsby application for these documents is included in this repository.
Use Dockerfile.dev
and docker-compose.dev.yaml
for local development using gatsby-cli
.
Copy the example .env
files and fill them with your environment variables:
cp .env.development.example .env.development
cp .env.production.example .env.production
GATSBY_GOOGLE_CUSTOM_SEARCH_API_KEY
is a Google Cloud Platform API key that needs access to the Custom Search APIGATSBY_GOOGLE_SEARCH_ENGINE_ID
refers to a specific Google custom search engine instanceGATSBY_GOOGLE_SITE_VERIFICATION
is a meta tag value that ties the Google custom search engine instance to a specific instance of our deployed Gatsby site, allowing us to access information about the pages indexed by Google in Google Search ConsoleGATSBY_WORDPRESS_SITE_BASE_URL
is used by./gatsby-config.js
to allow us to link to our WordPress site in a tokenized fashion from our Markdown documents
Use Dockerfile.prod
and docker-compose.prod.yaml
for a production build served by nginx.