Skip to content

DEVELOPER_GUIDE.md

Latest commit

 

History

History
37 lines (23 loc) · 1.85 KB

DEVELOPER_GUIDE.md

File metadata and controls

37 lines (23 loc) · 1.85 KB

Developing the CALM DOCS

The CALM documentation is presented using Docusaurus. Content is generated from Markdown files within the docs directory, starting with index.md.

Running locally

From within the project folder (which contains this developer guide), run these commands to give you a locally-running Docusaurus server:

npm install
npm run serve -- --build

For options such as changing the ports, see the Docusaurus docs.

Whilst the server is running, if you run npm run build then it'll pick up any changes you've made to the source Markdown files. You can then simply refresh the browser to view.

Committing changes

See the main contributing guide for details on commit standards, etc.

OWASP DEPENDENCY-CHECK

The OWASP dependency check tool will run on PRs and periodically on the committed code, but it can be helpful to be able to run this locally to investigate CVEs.

To use the dependency check tool locally, first install the tool following the instructions for your operating system here.

Once that is done the tool is configured as a script in the package.json, run npm run dependency-check; the reports will be output to cli/dependency-check-report.

Search Configuration

The documentation uses Algolia DocSearch for full-text search.

To configure search locally or for production:

  1. Apply for DocSearch at https://docsearch.algolia.com/apply
  2. Once approved, Algolia will provide an appId and apiKey
  3. Update docusaurus.config.js with these credentials
  4. The crawler configuration is managed by Algolia, but runs weekly to index the content