Documentation

ZenHub

As an Open Source community, it is necessary for our work, communication, and collaboration to be done in the open. GitHub provides a central repository for code, pull requests, issues, and documentation. When applicable, we will use Google Docs for design reviews, proposals, and other working documents.

While GitHub issues, milestones, and labels generally work pretty well, the Velero team has found that product planning requires some additional tooling that GitHub projects do not offer.

In our effort to minimize tooling while enabling product management insights, we have decided to use ZenHub Open-Source to overlay product and project tracking on top of GitHub. ZenHub is a GitHub application that provides Kanban visualization, Epic tracking, fine-grained prioritization, and more. It’s primary backing storage system is existing GitHub issues along with additional metadata stored in ZenHub’s database.

If you are a Velero user or Velero Developer, you do not need to use ZenHub for your regular workflow (e.g to see open bug reports or feature requests, work on pull requests). However, if you’d like to be able to visualize the high-level project goals and roadmap, you will need to use the free version of ZenHub.

Using ZenHub

ZenHub can be integrated within the GitHub interface using their Chrome or FireFox extensions. In addition, you can use their dedicated web application.

Getting Started

To help you get started, see the documentation.