Configure the tutorial system

Prepare your system so that you can complete the tutorial.

Tutorial team

Before you begin the tutorial, make sure that you review the Prerequisites. To complete the tutorial, your HCL Accelerate user ID must have sufficient permissions to create value streams and configure plug-in integrations. HCL Accelerate uses team- and role-based security. Teams own their user-created objects, such as value streams and deployment plans. All team members can access team-owned objects, although team members might have different permissions. Some team members might only be able to view team objects while other users can create and edit them. Permissions are granted to roles. When you add users to a team, they inherit the permissions granted to their assigned roles. Users can be in multiple roles on a team. It's typical for one team member to be in the Team Administrator role in addition to any other role that they might be assigned. Users can also be on multiple teams and be in different roles on each one. On the tutorial team, your user ID should be assigned to a role with the required permissions.
Note: If you are the HCL Accelerate administrator, you can use the Default team. The system admin role is automatically assigned to this team, and it has all permissions.

In addition to a team and a role, you need access to a a Jira project and connection information, such as the project name and URL.

To prepare the tutorial team, complete the following steps:

  1. Create a team that you can use throughout the tutorial. If you do not have administrative privileges, ask your administrator to create a Tutorials team for you.
  2. On the Tutorials team, assign your user ID to the Lead Developer role or a group that has this role. A Tutorials team is ideal for new users who are onboarding by working though the tutorials. You might want to create an user ID that is only assigned to the Tutorials team, and can be used by all new users.

Using the value stream from the Create a value stream tutorial

The Create a value stream tutorial describes how to create a value stream and customize it by adding a Jira project. The value stream defined in that tutorial is an ideal starting point for this tutorial. If you completed that tutorial, you can use the value stream that you created in that tutorial. You can also use the Jira project that you configured in that tutorial.

If you did not complete the Create a value stream tutorial, you can get a head start on this tutorial by downloading a file that contains the value stream defined in that tutorial. To use the value stream template, replace property placeholders with values corresponding to your environment:

Setting up GitHub for the tutorial

To complete the tutorial, you need a GitHub repository for which you have write permission. In addition, you need a GitHub personal access token. The personal access token enables you to access the GitHub API, and to integrate GitHub repositories into HCL Accelerate. After a repository is integrated into a value stream, you can access the pull requests associated with the repository.

Setting up a Jira project

To integrate Jira into the tutorial value stream, you need a Jira project and Jira API key. If you already have a Jira project, you can use that for the tutorial. If you do not have a project already setup, you can follow the instructions provided in the Create a value stream tutorial. After the Jira project is integrated into a value stream, you can access project data and mange Jira issues.