Skip to content

Commit

Permalink
Merge pull request #88 from cmu-sei:reederr-gb-doc
Browse files Browse the repository at this point in the history
Support section updates
  • Loading branch information
sei-rreeder authored Feb 18, 2025
2 parents 8238557 + 758973c commit 54d5f2e
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions docs/gameboard/support.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
# Getting in-game support

The Gameboard platform comes with a built-in customer support interface so that competition hosts and administrators can assist competitors and players. This way, Gameboard is a "one-stop shop" and no outside apps or systems are required to track and measure issues reported by participants.

You must have either the `Support` role or `Admin` role to use the support feature and manage tickets. Assuming you have been granted the appropriate role in Gameboard, select **Support**.
The Gameboard platform comes with a built-in customer support interface so that competition hosts and administrators can assist players and teams. Gameboard is a "one-stop shop" and no outside apps or systems are required to track and measure issues reported by participants. Users who have been granted a role with the appropriate permissions can use the support feature to manage tickets.

## Support from participant point-of-view

### Creating new support ticket

You can create tickets from two places: the *Support* page or a challenge screen. In both cases you click the blue **Create Ticket** button to get started. If you are coming from the challenge screen, then the Support Code, player id, and challenge id are automatically generated; if you are not, then this information can be added later.
You can create tickets from two places: the Support screen and the challenge screen. If you are coming from the challenge screen, then the Support Code, player id, and challenge id are automatically generated; if you are not, then this information can be added later.

From the Support screen:

In the **Summary**, enter a brief statement of the problem.
1. In the top navigation, click **Support**.
2. Click **Create Ticket**.
3. In the **Summary**, enter a brief statement of the problem.
4. In the **Description**, enter a more detailed statement of your problem. Include error messages and other pertinent details.
5. Under **Attachments**, attach files (especially screen shots) here.
6. Click **Submit**.

In the **Description**, enter a more detailed statement of your problem. Include error messages and other pertinent details.
After submitting the ticket, you can always **add a comment** and attach another file. Updates to a ticket are tracked under Activity. View a status change or an assignment change here too.

Under **Attachments**, attach files--especially screen shots--here.
From a challenge screen:

Click **Submit**.
These instructions assume you have enrolled in a game, started a session, and started a challenge.

After submitting the ticket, you can always **add a comment** and attach another file. Updates to a ticket are tracked under Activity. View a status change or an assignment change here.
1. In the *started* challenge, scroll to the bottom of the challenge instructions.
2. Click **Create Ticket**. Notice that the challenge is automatically populated in the **Challenge** field.
3. In the **Summary**, enter a brief statement of the problem.
4. In the **Description**, enter a more detailed statement of your problem. Include error messages and other pertinent details.
5. Under **Attachments**, attach files (especially screen shots) here.
6. Click **Submit**. Because you are coming from the challenge screen, a link to the game lobby is generated and Support Code is provided.

### Finding an existing ticket

From the Support page, use the dropdowns and the **Search** field to locate existing tickets. Filter tickets by status:
From the Support page, use the dropdowns and the **Search** field to locate specific tickets from *all* of the tickets you have submitted.

Filter tickets by status:

- Any Status
- Open
- In progress
- In Progress
- Not Closed (*Open* plus *In Progress*)
- Closed

Filter by *Assigned to me*, *Unassigned*, and *Any Assignment*. Finally, you can also *Filter by labels*. Filtering by labels returns tickets with only a specific label attached.

Search by entering terms. Search covers ticket description, label, user, challenge title, and player.

## Support from the Support role point-of-view

Click the links in the ticket header to instantly jump to the player's *Game* and *Challenge* details.

### Creating new support ticket
### Creating new support ticket (support staff)

The procedure for support staff (i.e., users given the `Support` role) to create a tickets is very similar to procedure for participants to create a ticket (see above). However, after a ticket has been created users with the `Support` role have more options to manage the tickets.

Expand Down Expand Up @@ -68,4 +78,4 @@ The **Copy to markdown** icon allows you to copy support ticket content to Markd

## Support-related Reporting

Support-related reporting provides you with a way to manage workloads and track trends during your competition. In the main menu, select **Reports**. Then click **Support** in the Reports screen.
Support-related reporting provides you with a way to manage workloads and track trends during your competition. In the main menu, select **Reports**. Then click **Support** in the Reports screen.

0 comments on commit 54d5f2e

Please sign in to comment.