Skip to content

Contributor Quick Start Guide

janiksam edited this page Mar 31, 2023 · 5 revisions

The Voucherify Documentation team receives contribution through Github and directly on our Documentation site.

Voucherify Documentation website - Suggest Edits

Use the Suggest Edits button to suggest edits on a given page.

Screenshot 2023-03-31 at 18 16 37

Github

There are two ways you can contribute using Github.

Pencil Icon

  • Go to the voucherify-openapi repo and click on the < > Code tab
  • Navigate through the docs folder to find the page that you would like to edit
    • guides: documents that are in the Guides section of the documentation
    • reference-docs: documents that are in the API Reference section of the documentation
  • Click on the page
  • Click on the pencil icon in the page's toolbar to start editing

Pull Request - Local Environment

  1. Fork a copy of the voucherify-openapi repository to your local machine
  2. Make edits
  3. Push changes

Navigating the Documentation

Guide content is located in a subfolder within docs.
API Reference endpoints are located in reference.

Contributing

  1. Sign CLA
  2. Find page through GitHub or the Docs website
  3. Make edits
  4. Submit proposed changes
  5. Request approval