README.md

docs.pactflow.io

PactFlow technical documentation

This doco site is generated with Docusaurus

There are two main directories. All the website assets (pages, css, images) is in website and the documentation pages are found in docs.

Refer to website/README.md

Development

docker-compose up

Environments

Test: docs.test.pactflow.io

Prod: docs.pactflow.io

Search

Search is provided by Algolia and the dashboard is here

The config is stored in ./scripts/crawl/crawlconf.json

You will need to set an api admin key which you can get here

export PACTFLOW_ALGOLIA_KEY=xyz
export PACTFLOW_ALGOLIA_APP_ID=LY8MHW6MWQ

and it can be run by

make crawl

Annotated UI images

Images demonstrating the PactFlow UI have been annotated using Figma. Styles and examples can be found here. Access for editing granted on request.

Troubleshooting

Error: error:0308010C:digital envelope routines::unsupported at String.replace ()

This is due to a compatibility issue with the version of Webpack and Node 18+.

To address this, you can use an older version of Node, or simply allow the legacy OpenSSL provider:

export NODE_OPTIONS=--openssl-legacy-provider
npm start

The real fix, of course, is to upgrade webpack.