cado-security/product-help

Product help and user guides

Initial Setup

The below is based on the instructions outlined here https://docusaurus.io/docs/installation which outlines how to install Docusaurus.

1. Make sure you install Node.js version >= 18 prior to installing Docusaurus.
2. Open a command window and run npx create-docusaurus@latest default-site classic which will scaffold a skeleton Docusaurus website. This command also creates a sub-folder called default-site in whatever directory you run the npx command in.
3. Change directories into the default-site folder (example: cd default-site) and run npm start to test whether the scaffold Docusaurus development server runs locally without issues.
4. Clone this repo (https://github.com/cado-security/product-help) into your local source folder (wherever you'll be maintaining the product-help code).
5. Copy the following folders from the Docusaurus "default-site" folder, created during step #2, to your local source "product-help" folder:
   • .docusaurus
   • node_modules
6. Run npm install @cmfcmf/docusaurus-search-local to install local search (https://github.com/cmfcmf/docusaurus-search-local)
7. Run npm install --save @docusaurus/plugin-client-redirects to install redirects
8. Change directories into your "product-help" source folder and run npm start. This should now open the Cado product-help site locally.

Build

npm build

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

Deployment to Github Pages

New PRs merged to main will automatically be built and deployed to GH Pages.