Welcome to ZenHub! To ensure you hit the ground running, let's take a look at creating your very first Workspace so that you can collaborate with your team and ship better software!
|Skill||To be completed|
|- Name a Workspace|| ✅|
|- Connect one or multiple repositories to your Workspace|| ✅|
|- Set a default Workspace||✅|
A Workspace is how you bundle GitHub repositories into a single view. A Workspace can be made up of multiple GitHub repositories or you can also create a single repository Workspace. Workspaces are inspired by kanban boards and present a simple yet incredibly robust picture of your software projects. They allow you to track GitHub Issues and Pull Requests end-to-end through the release cycle.
A GitHub repository can be added to more than one ZenHub Workspace. This means each team can create their own Workspace and pipeline structure for the same repo or set of repos. This empowers teams to visualize the status of an Issue according to their own process and workflow. When viewing an Issue belonging to multiple Workspaces, you can easily view how it is progressing in each Workspace pipeline it belongs to.
Don't worry—When you create a new Workspace, it won't affect repos or Issue placement in existing Workspaces. Learn more about how your team can use Workspaces!
Creating your first Workspace
Let's get your first Workspace set up so that it looks and feels like home for you and your team! You can create a Workspace in either the ZenHub web app or the ZenHub extension.
Web app: When navigating in ZenHub, you can create a Workspace at any time through the Create new Workspace button on the Workspace navigator:
ZenHub Extension: Alternatively, you can create your first Workspace from directly within GitHub. To do this, make sure you have installed the ZenHub extension on Chrome or Firefox. You can then navigate to the ZenHub tab from within one of your GitHub repositories. From here you will be prompted to create a Workspace
You can then give your Workspace a name and a description. Descriptions are optional but highly recommended. This will help provide clarity for the team on the purpose of the Workspace. This is especially helpful if you have similar repos, but slightly different use cases per-repo.
Workspace names have to be unique within ZenHub. No two ZenHub Workspaces can be named the same. Names are searched independent of case—If you name one Workspace Design and attempt to name a second design, you'll be prompted to create a unique name.
Once you have added a name and description for your Workspace you can then add any repositories you would like to be part of this Workspace. You can add multiple repositories to the Workspace by selecting the the Add a repo + option.
Using the avatar on the bottom left of the modal, you can toggle across all organizations and personal repositories that you have access to. If the repository you'd like to add is in another one of your GitHub organizations, you can connect this using the custom link on the bottom left, where the avatar for your organization is located:
Once you've selected the repositories you want in your Workspace, be sure to set a default. This default is where new Issues will be created and is a custom setting that every individual can set. The default setting applies only to you, for when you create new Issues.
All of the Issues within the repositories added to the Workspace will be included in the Workspace. It is not possible to only add certain Issues from different repositories to a Workspace. For more information on creating Workspaces, check out: Creating and naming ZenHub Workspaces
Once you are happy with the repositories you'd like to connect, click Create new Workspace.
You're all set, you have just created your first Workspace!