Contribution guidelines

How to contribute to the K8ssandra open-source code and documentation.

We welcome contributions from the K8ssandra community!

Code contributions

The overall procedure:

  1. Start on https://github.com/k8ssandra/k8ssandra.
  2. Fork the repo by clicking the Fork button in the GitHub UI.
  3. Make your changes locally on your fork. Git commit and push only to your fork.
  4. Wait for CI to run successfully in GitHub Actions before submitting a PR.
  5. Submit a Pull Request (PR) with your forked updates.
  6. If you’re not yet ready for a review, add “WIP” to the PR name to indicate it’s a work in progress.
  7. Wait for the automated PR workflow to do some checks. Members of the K8ssandra community will review your PR and decide whether to approve and merge it.

Also, we encourage you to submit Issues, starting from https://github.com/k8ssandra/k8ssandra/issues. Add a label to help categorize the issue, such as the complexity level, component name, and other labels you’ll find in the repo’s Issues display.

Setting up CI in GitHub Actions

CI will run on push to any branch of your forked repository. In order to run CI jobs involving S3 or Azure buckets (for Medusa), the following GitHub secrets need to be set up in the fork’s organization:

  • K8SSANDRA_MEDUSA_BUCKET_NAME: Name of the S3 bucket or Azure container used to store Medusa backups.
  • K8SSANDRA_MEDUSA_BUCKET_REGION: Region of the S3 bucket (for Amazon S3 tests only).
  • K8SSANDRA_MEDUSA_SECRET_S3: A valid Kubernetes secret definition to access the S3 bucket (for Amazon S3 tests only). See below for an example.
  • K8SSANDRA_MEDUSA_SECRET_AZURE: A valid Kubernetes secret definition to access the Azure storage account (for Azure tests only). See below for an example.

Kubernetes secret definitions for Medusa tests

When testing Medusa on Amazon S3, the GitHub K8SSANDRA_MEDUSA_SECRET_S3 secret must contain a valid Kubernetes secret definition similar to the one below:

apiVersion: v1
kind: Secret
metadata:
  # The name must be medusa-bucket-key!
  name: medusa-bucket-key
type: Opaque
stringData:
  # The entry must be named medusa_s3_credentials!
  medusa_s3_credentials: |-
    [default]
    aws_access_key_id = <your key id>
    aws_secret_access_key = <your key secret>    

See Backup and restore with Amazon S3 for more information.

When testing Medusa on Azure, the GitHub K8SSANDRA_MEDUSA_SECRET_AZURE secret must contain a valid Kubernetes secret definition similar to the one below:

apiVersion: v1
kind: Secret
metadata:
  # The name must be medusa-bucket-key!
  name: medusa-bucket-key
type: Opaque
stringData:
  # The entry must be named medusa_azure_credentials.json!
  medusa_azure_credentials.json: |-
    {
        "storage_account": "<your storage account name>",
        "key": "<your storage account key>"
    }    

See Backup and restore with Azure Storage for more information.

Prevent CI from running for a specific commit

CI runs can be disabled for specific commits by adding [skip ci] in the commit message. This can be useful when pushing commits on WIP branches for backup purposes.

Documentation contributions and build environment

We use Hugo to format and generate this website, the Docsy theme for styling and site structure, and Google Cloud Storage to manage the deployment of the site.

Hugo is an open-source static site generator that provides us with templates, content organization in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Most of the documentation source files are authored in markdown plus some special properties unique to Hugo.

Deploying to K8ssandra.io

Here’s a quick guide to updating the docs. It assumes you’re familiar with the GitHub workflow and you’re happy to use the automated preview of your doc updates:

  1. Fork the K8ssandra docs repo on GitHub.
  2. Make your changes and send a pull request (PR).
  3. If you’re not yet ready for a review, add “WIP” to the PR name to indicate it’s a work in progress. (Don’t add the Hugo property “draft = true” to the page front matter.)
  4. Wait for the automated PR workflow to do some checks.
  5. Continue updating your doc and pushing your changes until you’re happy with the content.
  6. When you’re ready for a review, add a comment to the PR, and remove any “WIP” markers.
  7. After the Pull Request is reviewed and merged it will be deployed automatically. There is usually a delay of 10 or more minutes between deployment and when the updates are online.

Updating a single page

If you’ve just spotted something you’d like to change while using the docs, K8ssandra.io has a shortcut for you:

  1. Click Edit this page in the top right hand corner of the page.
  2. If you don’t already have an up to date fork of the project repo, you are prompted to get one - click Fork this repository and propose changes or Update your Fork to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
  3. Follow the rest of the Deploying to K8ssandra.io process above to make and propose your changes.

Previewing your changes locally

If you want to run your own local Hugo server to preview your changes as you work:

  1. Follow the instructions to install Hugo and any other tools you need. You’ll need at least Hugo version 0.45 (we recommend using the most recent available version), and it must be the extended version, which supports SCSS.

  2. Fork the K8ssandra repo repo into your own project, then create a local copy using git clone. Don’t forget to use --recurse-submodules or you won’t pull down some of the code you need to generate a working site.

    git clone --recurse-submodules --depth 1 https://github.com/k8ssandra/k8ssandra.git
    
  3. Run hugo server in the docs site root directory, such as your ~/github/k8ssandra/docs directory. By default your site will be available at http://localhost:1313/. Now that you’re serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.

  4. Continue with the usual GitHub workflow to edit files, commit them, push the changes up to your fork, and create a pull request.

Creating an issue

If you’ve found a problem in the docs, but you’re not sure how to fix it yourself, please create an issue in the K8ssandra repo. You can also create an issue about a specific page by clicking the Create Issue button in the top right hand corner of the page.

Next steps

Refer to these useful resources:


Branching model for the K8ssandra project

How to branch and release K8ssandra.


Last modified July 22, 2021: Fix links format (#999) (aac72ff)