Zube Docs | Getting Started

Sign Up

You can get started using Zube by signing up with either GitHub or Google OAuth.

Hint:

You must use GitHub authentication to import GitHub repositories into Zube.

GitHub Authentication

Logging in with GitHub allows you to change your GitHub Issues data directly from Zube. If you have a GitHub account and are using Zube for software development, you'll want to choose this option. Using GitHub authentication will allow you create new GitHub Issues directly from Zube as well as comment as yourself.

Tip:

GitHub requires write access to your repositories in order to manage Issues, however Zube never reads from or writes to your source code in any way. Zube only accesses information related to GitHub Issues.

Google Authentication

Logging in with Google is easy and secure.

Tip:

If you have multiple Google accounts make sure you choose the appropriate account. For example, you may have a personal email account like your.name@gmail.com and a work email like name@company.com. You'll most likely want to choose your work account when signing up for Zube.

Organizations

Zube organizations are the home base for your different projects. After logging into Zube, you will be able to either create a new organization or join an existing organization.

Tip:

If you signed up with GitHub and are a collaborator on GitHub repositories that are being managed in Zube, you will be automatically added to those projects. To create a new organization, click the blue button at the top right of the page.

If you signed up for Zube through the GitHub Marketplace, your organization will be created automatically and you will be prompted to create your first Project. Skip to Creating a Project.

Create an Organization

To create a new organization on Zube, click "Create a new Organization" button to bring up the new organization form. If you logged in with GitHub, you'll have the option to add a GitHub organization. Enter your organization name, select a GitHub organization (optional) and click 'Create Organization'.

Tip:

Optionally, you can link a GitHub organization to your Zube organization. You'll want to go this route if you'd like to use Zube to help manage your GitHub Issues. Note that a GitHub organization can be linked to one and only one Zube organization.

Create a Project

After you create a new organization, it's time to make the first Project for your organization. Projects are the highest level containers for your workflow on Zube and contain project management components such as Tickets, Triage and Workspaces.

If your organization is linked to a GitHub organization (and you have signed in with GitHub), you'll be able to select one or more source repositories to import into your Project. Projects can have many source repos, but source repos can only belong to one Project. Give your Project a name, description and optionally link one or more GitHub source repositories. When you're ready, click 'Create Project'.

If you attached any GitHub repositories to your Project, Zube will import the Issues from those repos to your Project. Once the import is complete, you'll be redirected to your Workspace where you can begin managing your project!

Join an Organization

To join an existing organization on Zube, click "Join an existing Organization" button to bring up the organization search form. If you signed in with your GitHub account and have access to a GitHub organization already linked to a Zube organization, you be able to select it from the GitHub organization drop down list.

You can also use the organization search box to search for a Zube organization by name. Selecting a Zube organization by name will send an approval request to the organization admins. Organization admins can either approve the request, which will add the requester to the organization, or deny the request.

Adding Team Members

Once you've created your first Project, you'll probably want to have the rest of your team join in as well. To add team members to your Project, they must be part of your organization.

To add new team members, go to the organization settings page. Under the Organization Members' tab, you'll see a list of the organization admins and members and a search box to look for teammates on Zube. You can send email invitations to your team members via the "Invite Team Members" form. If your team members have already joined Zube, you can use the search box to find them by name, username, or email address.

If your organization is linked to a GitHub organization, you will also see a list of GitHub Collaborators. This is a list of people who are collaborators on your project sources but are not members of your Zube organization. You can use the invite form to send them an email inviting them to join your Zube organization.

Once your team members have been added to your Zube organization, you can add them to any of your Zube Projects. Team members can be added to Projects via the Project Settings page for each project under the 'Users' tab.

Tip:

Team members who sign up with GitHub and are collaborators on GitHub repositories that are being managed in Zube, they will be automatically added to your organization.

TL;DR:

You can invite new team members to Zube or search for people already on Zube to add to your organization. Once team members are on your organization, you can add team members to any of your organization projects.

The Zubebot GitHub Integration

If your organization has a linked GitHub organization, we recommend installing the Zubebot GitHub Integration to make communication across your team seamless. The Zubebot allows your non-technical team members and team members with read-only access to your source repositories to communicate with your developers without giving them write access to your GitHub repositories.

Hint:

You must be an owner of the GitHub organization to install the Zubebot GitHub integration.

Adding the Zubebot to Your Organization

To add the Zubebot GitHub integration to your organization:

On Zube, navigate to your Zube organization's settings page and click the Integrations tab.

Note: You can get to your Zube organization's settings page via the homepage by clicking the "organization settings" link next to the name of your organization.
Make sure there is a GitHub organization linked to your Zube organization. If not, link your GitHub organization.
Click the 'Install Zubebot' button.
In the new window, click the 'Install' button (or 'Configure' button).
If you are the owner of multiple GitHub organizations, choose the appropriate GitHub organization.
Select the repositories you want to give the integration access to (we recommend selecting 'All repositories')
Click the install button at the bottom of the screen to authorize the Zubebot integration
Navigate back to Zube, sit back and enjoy seamless communication across your entire team!
* Your browser should automatically refresh to pull in the changes.

Tip:

The Zubebot allows your non GitHub team members to comment on, edit, close and reopen cards that are backed by GitHub Issues.

Next: Learn about Zube Agile project management components