The files are markdown, stored under the docs directory.
You will need Docker and Docker Compose to run the docs application locally.
docker-compose up
- Add the file to the appropriate path under the
docsdirectory. - Update website/sidebars.json.
- Find the file under the
docsdirectory. - Move it to the directory/name you want.
- Update website/sidebars.json.
- Do a file search and replace to update any internal references to the page.
- Create a redirect in netlify.toml.
The markdown files in the following directories are synced from their respective source repositories. Do not edit them directly! You'll be able to tell if it's a file that has been synced from another repository because the custom_edit_url will be set in the page metadata.
docs/implementation_guides/godocs/implementation_guides/javascriptdocs/implementation_guides/jvmdocs/implementation_guides/pythondocs/implementation_guides/cppdocs/implementation_guides/rustdocs/implementation_guides/netdocs/pact_broker/client_clidocs/pact_broker/docker_images/
Each of the above Pact repositories has a Github workflow that triggers the sync-docs workflow when any markdown files are edited on master.
When the sync-docs workflow runs, it pulls in the master markdown files from the changed repository, syncs and processes them, and then commits and pushes them. On push, Netlify automatically deploys.
The Pact docs site is hosted by Netlify. Thanks!
The site will be automatically redeployed after any push to master.
The search is provided free by Algolia because Pact is an open source project. It is configured in docs.pact.io in website/siteConfig.js. It is configured in Algolia in https://github.com/algolia/docsearch-configs/blob/master/configs/pact.json The Algolia analytics page is here. Currently only Beth has access to it via her Github login. We may be able to add extra people, but she hasn't looked into that yet. Info on how to style the search UI is here.
See CONTRIBUTING.md