Wazo Platform Website

This repo contains the source and building scripts for generating https://wazo-platform.org/.

Content Change

• The content is authored using the Markdown language.
• Blog posts, release notes and user documentation are edited under website/, the root for the Docusaurus beta site. The production Gatsby build then syncs them into content/blog and content/uc-doc, which are autogenerated — do not edit them directly. Ref. package.json and scripts/beta-sync.sh.
• Other pages (service/API docs, tutorials) are authored directly in the content directory. Service diagrams live there twice: as <name>.puml, which the Gatsby build renders to <name>.svg, and as <name>.mmd, which the Docusaurus build inlines as a mermaid block in place of the .svg image reference. Keep both in sync when editing a diagram.

Installation

Build the builder container:

make builder
cp config.sample.js config.js  # the config.js file must exist

In config.js, you can configure the Algolia credentials used for the search engine. If left empty, the search engine will be disabled.

Develop

make ENV=CORPORATE=1 develop

Then open http://localhost:8000 in your favorite browser.

styling

There is a top-level .prettierrc file for the prettier formatter.

For uc-doc Markdown documents, the command yarn format:uc-doc should be used (and will be checked by CI).

Building

make ENV=CORPORATE=1 build

The documentation is built in the public/ folder, you can then run a simple HTTP server:

cd public/
python3 -m http.server

Then open http://localhost:8000 in your favorite browser.

Testing

make test