Website

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

Installation

npm install

Local Development

For search to work in local environment, you should have a valid algolia search api key. Create a .env file and add it in to get it started. You can follow the example in .env.example file.

Note: Please ask around the team for OA documentation algolia search api key.

Once you have the api key, you will be able to run the following command:

npm run start

Note: Please use node version 16.14.0 and above to run.

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

Build

npm run build

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

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Env

For env variables, check with any of the devs.