SAK Contributing - Evanto/qna GitHub Wiki

Contributing Guide

What You Can Help With

Currently, we accept contributions to the documentation of modules, specifically README.md files of each module. You can contribute in the following ways:

  • Create a new Readme that is currently missing, add structure and write it in full or in part
  • Add missing sections, paragraphs, and information to existing READMEs
  • Correct typos and formatting issues
  • Add/propose graphics to illustrate documentation

Getting Started

Swiss Army Kube documentation welcomes improvements from all contributors, new and experienced. Anyone can contribute to the github.com/provectus/swiss-army-kube repository in the following formats:

  1. Open an issue about the documentation
  2. Propose a change with a pull request (PR)
  3. Propose minor text/formatting edits right on GitHub without cloning

All you need is being comfortable with Git and GitHub.

Contributing Issues

Find an issue to work on or create your own. If you are a new contributor take a look at issues marked with good first issue.

Contributing Pull Requests (PRs)

Please check our guide on how to contribute to Swiss Army Kube with PRs:

Select a Module to Contribute

The list of all Swiss Army Kube modules below includes information on the current state of documentation for each Module. Please select a module to contribute:

Structure of a Module's README

Approximate structure of a README.md document:

  • Module Description
  • Implementation
  • Usage
  • Configuration
  • Overrides

In some cases, modules won't need some of these sections or require additional ones. Change it according to a particular module.

Back to top