Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.92 KB

Contributing

Contributions are very welcome, from beginners and experienced Pact users alike. Please chat to us in the #documentation channel of the Pact Foundation Slack workspace (signup|login) if you have any questions or suggestions, or raise an issue in the Github repository for bugs that you can't submit a PR for yourself.

Content updates

  • Click on the EDIT link of the page you want to update.
  • You will be prompted to create a fork. Please do so.
  • Make your changes.
  • Open a PR back to the docs.pact.io repository.

You can test our your changes locally if you have Docker Compose by cloning your fork and running docker-compose up.

Page additions/deletions/relocations

For more significant changes, like adding pages or changing URLs, you will need to checkout the repository locally. See the instructions in the README.

Syncing docs from a new repository

  1. Prepare development environment
    1. Install Ruby 2.6 ish
    2. Install the bundler gem gem install bundler -v 2.0.2
    3. Install the gems bundle install
  2. Copy one of the sync scripts from /scripts/sync and modify it to sync from the desired repository to the desired path.
  3. Run it by executing bundle exec scripts/sync/your_new_script.rb
  4. Update /website/sidebars.json to include the new section and pages.
  5. Update .github/workflows/sync-docs.yml with an event for the new repository.
  6. In the source repository, copy this workflow into the corresponding location.
  7. If the source repository is in the pact-foundation organisation and you have permissions, modify the scope of the GHTOKENFORTRIGGERINGPACTDOCSUPDATE secret so that it can be used by the repo. Otherwise, ask @bethesque to do it.