Getting started using TeamHub

This section provides instructions on how to:

Create a project

In TeamHub, each project is an isolated entity with its own team, repositories, milestones and so on. Projects are created at the company scope level. A company can have multiple projects. The project's team, for example, is formed by granting access to individual company users, groups or bots, and giving them appropriate project roles.

To create a project

  1. Log in to the TeamHub user portal as the company admin user: <TeamHub-instance-URL>/login
  2. Click the Quick Actions button Quick Actions button and select New project.
  3. In the New project form, provide a name and, optionally, a short name and description.
  4. Click Create project.

    The new project appears in the My Dashboards view under MY PROJECTS.

Create a Git repository

Creating a Git repository to be stored in Helix server requires that you provide the name of an existing graph depot and a short name for the new repository. As you provide this information, TeamHub dynamically creates the path to the new repository using the following format: <company>/projects/<project-name>/<short-repo-name>

For example: hth/projects/test/test-repo

You can edit this path to meet your needs, but it is recommended that you use the path provided.

To connect to your clean repository using Git, follow the instructions in TeamHub. If your repository already hasAdd your content data, it is displayed on the page. In this case, continue with cloning the repository. For more information on setting up Git repositories, see Version control with Git.

Important

Make sure that the gconn-user has admin permission for the graph depot that holds your repository. For information on granting permissions, see the Helix4Git Administrator Guide, section Grant permissions.

To create a Git repository to be stored in Helix server

  1. In TeamHub, in the My Dashboard view, click the project you just created.

    The panel on the left changes to reflect the views available on the Project scope.

  2. In the Repositories view, click the add button add icon.
  3. In the New repository form, from the list of repository types, select Git.
  4. Select a depot from the list of existing graph depots in Helix server.

  5. Enter a short name for the repository. This is the repository name displayed in the TeamHub UI.

  6. (Optional) If needed, edit the path under the selected Helix graph depot.

    Note

    Modifying the path is not recommended.

  7. Verify that the full path displayed at the bottom of the form is correct.

  8. Click Create.

Invite users

To invite others to test the TeamHub Testdrive instance, you can create users in TeamHub. Each user that you create receives an email invitation with a link to finalize the registration. Upon login, TeamHub prompts new users to change their password. It then syncs the new password to Helix server. From here on, all user management is performed solely in Helix server (see (Optional) Add groups and configure group access).

To invite users

  1. Log in to the TeamHub user portal as the company admin user: <TeamHub-instance-URL>/login
  2. To make sure you are at the company scope level, click the company name or logo in the top left corner. Then click Users.
  3. In the Users view, click the Quick Actions button Quick Actions button and select New User.
  4. In the New User form, provide an email address and, optionally, a username.
  5. Click Create.

(Optional) Add groups and configure group access

While the TeamHub Testdrive version lets you create new users in the TeamHub UI, subsequent user and group management is disabled. Instead, you manage users and groups on the Helix server side.

See the following sections in the Helix Core Server Administrator Guide:

Warning

In Helix server, do not alter or edit groups with a name following this convention in any way:

HTH-//<depot-path>/<repo-path>-<HTH_ACCESS_LEVEL>

To add groups and configure group access

  1. (Optional) To add a new group, from the p4 command line, run:

    p4 -u admin -p <P4PORT> group <groupname>

    where:

    • P4PORT is the host name or IP address of your TeamHub Testdrive instance followed by a colon and port number. For example: testdrive.helixteamhub.com:1666
    • groupname is the name of the group you want to add

    Following is a sample group spec:

    Group:    hth-group
    MaxResults: unset
    MaxScanRows: unset
    MaxLockTime: unset
    MaxOpenFiles: unset
    Timeout: 43200
    PasswordTimeout: unset
    Subgroups:
    Owners: admin
    Users: hth-user
    Note

    Make sure you specify a group owner in the Owners field. Every group must have a specified owner.

  2. Edit the group spec by adding the required users to the Users: section.
  3. In TeamHub, add the group to your project:

    1. In the My Dashboard view, click the project to which you want to add the group.

      As you click, you see the views in the left pane change.

    2. Click Team and select the Groups tab.
    3. On the Groups tab, click and select Add groups from the drop-down list.
    4. In the Add project groups form, click the group you just created (hth-group in the example group spec above).
    5. From the drop-down list, select the role with which you want to add it to the project.

      Note

      To be able to push to a repo, a user or group needs a role of Developer or higher. For more information on Helix TeamHub roles, see the Roles chapter in the Helix TeamHub User Guide.

      The Add project groups form closes, and the GroupsProject roles tab now displays a table that indicates the groups added to a project along with their assigned roles.

      For more information on Helix TeamHub roles, see the Roles chapter in the Helix TeamHub User Guide.

Clone a repo to your local workspace

For a repository that includes content, go ahead and clone the repository. This requires that you first add your SSH key.

To clone a repository

  1. To add your SSH key:

    1. At the top right of the header, click the user avatar and select User preferences.
    2. In the form that opens, click SSH keys.
    3. In the SSH keys for, click Add new key.
    4. Enter a title and copy-paste your key into the Content field.
    5. Click Save.
  2. In the Repositories view, click the Git repository you want to clone.
  3. Click Clone, select the authentication method (HTTP, SSH, or Helix P4), and copy the path.
  4. Do one of the following:

    • If you selected HTTP or SSH, open the command line client and run the following command:

      git clone <paste the path you copied>

      For example, to clone the "bar" Git repository from the "foo" project in "acme" company with SSH, issue the following command in the Terminal:

      git clone hth@helixteamhub.cloud:acme/projects/foo/repositories/git/bar
      

      To clone the same repository with HTTP:

      git clone http://[HELIX TEAMHUB USERNAME]@helixteamhub.com/acme/projects/foo/repositories/git/bar
      
    • If you selected Helix P4, open a p4 command line client and run the following command to create a client of type graph; then edit the client spec accordingly.

      p4 -p <paste the port you copied> -u <user> client <client name>

      For more information on creating client workspaces for graph depots, see the Helix4Git Administrator Guide and the Helix Core P4 Command Reference, section Including Graph Depots repos in your client.