Skip to content

Commit

Permalink
many updates to the admin documentation sections (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
sei-rreeder authored Feb 21, 2025
1 parent 900c99a commit 76e44e7
Show file tree
Hide file tree
Showing 23 changed files with 156 additions and 229 deletions.
7 changes: 7 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"cSpell.words": [
"Gameboard",
"markdownguide",
"wwwroot"
]
}
2 changes: 1 addition & 1 deletion docs/caster/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Workspaces can contain files, which extend the configuration of the directory fo
A workspace is where users:

- Create an instance of a Terraform configuration
- Run their plans (_Runs_ are a specific instance of a Terraform plan; explained [here](./caster-run-plan-apply))
- Run their plans (*Runs* are a specific instance of a Terraform plan; explained [here](#run-plan-and-apply))
- Manage the differences and the variables in their environments

Users can access workspaces from a project's navigation pane in Caster. Users can add additional files, but _not_ additional directories, to a workspace. The workspace view allows users to see all the runs that have been planned and applied. Runs shaded in red are destroyed operations, while runs in white signify various other status classifications.
Expand Down
2 changes: 1 addition & 1 deletion docs/cite/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ When in Dashboard view, users will have two features to interact with moves:

The landing page of CITE provides a central approach to recompiling all evaluations that the user is a participant of into just one display.

![CITE Landing Page OE](../assets/img/CITELandingPage.png)
![CITE Landing Page OE](../assets/img/citeLandingPage.png)

*Search for an Evaluation*

Expand Down
7 changes: 0 additions & 7 deletions docs/gameboard/admin-clone-yaml-json.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/gameboard/admin-players.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Events seen on the player timeline are:

### Session Extension

Extends the player's session by a specified duration.
Extends the player's session by a specified duration. Gameboard will display a warning when an extension exceeds the game's end time. When the game ends, any player who does not have permission to participate outside of the execution period will be unable to submit answers. The warning includes a recommended game end date.

### Other tools

Expand Down Expand Up @@ -85,4 +85,4 @@ In the Player view context menu (the "three vertical dots") you'll notice four d
- **Reset Session:** If a player has registered and has started playing the game (i.e. they have a game session), you can reset their session. This deletes any challenge data they generated while playing but leaves enrollment and team membership intact. If they wish to play again, they'll need to start a new session.
- **Reset Session & Unenroll:** If a player has registered, and has started a session, you can *reset* their session and *unenroll* them from the game. Players will need to re-enroll to play again. Teams are essentially dissolved and will need to reform and re-enroll to play. This is the same functionality as when a player unenrolls from the game lobby or resets their session (when enabled by an admin).

Players can also unenroll themselves from the game lobby or reset their session if the admin setting **Allow Reset** is set to **Allowed** for their game. For the player perspective, see: [Participating in a game](participating.md).
Players can also unenroll themselves from the game lobby or reset their session if the admin setting **Allow Reset** is set to **Allowed** for their game. For the player perspective, see the [Game Lobby](home-and-lobby.md) documentation.
20 changes: 4 additions & 16 deletions docs/gameboard/admin-practice-area.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Admin Practice Area

Gameboard administrators configure the global Practice Area context here. In the main navigation bar, click **Admin**, then **Practice Area**.
Gameboard administrators configure the global Practice Area content here. In the main navigation bar, click **Admin**, then **Practice Area**.

## Practice Page Greeting

The text here appears on the Practice Area page and introduces players to the Practice Area. The greeting is authored in Markdown, which allows you to create a nicely formatted message. Customize the greeting to meet your needs.

More information about Markdown, including the syntax guide, can be found at [markdownguide.org]().
More information about Markdown, including the syntax guide, can be found at [www.markdownguide.org](https://www.markdownguide.org).

## Suggested Searches

Expand All @@ -18,9 +18,9 @@ To enter suggested searches, list one search term per line.

## Certificate Template

Admins configure the certificate template here by entering HTML into the **Certificate Template** field. Players save certificates in PDF format for each practice challenge they fully complete. More information on certificates can be found in the [Playing in the Gameboard](./participating.md) documentation under "The Profile screen" heading.
Admins configure the certificate template here by entering HTML into the **Certificate Template** field. Players save certificates in PDF format for each practice challenge they fully complete. More information on certificates can be found in the [Profile screen](profile.md) documentation.

For your convenience, here are several variables you can include in your template to display information about the player's performance on a practice challenge.
For your convenience, here are several variables you can include in your template to display information about the player's performance on a practice challenge.

- `{{playerName}}`: The player's approved username
- `{{score}}`: The player's score on the challenge
Expand All @@ -39,15 +39,3 @@ Admins use these controls to set limits on practice sessions, including:
- **Maximum Concurrent Users:** How many players can be active at once
- **Default Session Length:** How long in minutes practice sessions are by default
- **Maximum Session Length:** How long in minutes the maximum length a single practice session lasts

## Player Mode

In addition to the configuration required in the Admin Practice Area, the **Player Mode** must be set to **Practice** to publish a game in practice mode. Player Mode is a game setting found in **Admin**, hover over a game card, and select **Settings**. Expand **Settings**.

*In the screen print below, Player Mode is enabled.*

![player mode enabled](img/player-mode-enabled.png)

!!! tip

Gameboard administrators who are looking for reports on the Practice Area can find them by clicking **Reports** in the main navigation, then selecting the **Practice Area** card.
2 changes: 1 addition & 1 deletion docs/gameboard/admin-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You arrive at the **Admin Game Settings** by creating a new game or by editing a

**Paste Example Configuration:** Pastes sample feedback configuration into the Feedback Questions field for you to modify and use for your own needs.

**Certificate Template:** Design a certificate template here by entering HTML into the Certificate Template field. More information on certificates can be found in the [Playing in the Gameboard](participating.md) documentation under "The Profile screen" heading. For your convenience, selecting the **i** button displays instructions for designing a certificate that can dynamically display information related to a game, such as leader board rankings, player scores, and other details.
**Certificate Template:** Design a certificate template here by entering HTML into the Certificate Template field. More information on certificates can be found in the [Profile screen](profile.md) documentation. For your convenience, selecting the **i** button displays instructions for designing a certificate that can dynamically display information related to a game, such as leader board rankings, player scores, and other details.

## Modes

Expand Down
42 changes: 42 additions & 0 deletions docs/gameboard/admin-users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Users

To access the **Administration**, **Users** screen click **Admin** in the top navigation menu, then click **Users**. This is where users can be created, updated, deleted, assigned roles, and given API keys. Participant names are approved or disapproved here too. In Gameboard, a *user* is a person and a user has a *Name*.

## Searching, filtering, and sorting

To search for a user across the whole of Gameboard enter a term into the **Search** field.

To filter your results, select **Has Elevated Role**, **Has Pending Name**, or **Has Disallowed Name**.

- **Has Elevated Role:** contains only those participants who have been granted roles with additional permissions (Admin, Director, Support, Tester).
- **Has Pending Name:** contains only those participants whose display names are pending approval or disapproval from an admin.
- **Has Disallowed Name:** contains only those participants whose display names have been disapproved by an admin.

To sort your results, select **Name**, **Last Login**, or **Created On**. Click once to sort in **ascending** order (A → Z, oldest to newest). Click again to sort in **descending** order (Z → A, newest to oldest). The arrow (▲ or ▼), appears in the sort button to show the current sorting direction.

## Viewing a user card

Select **View** in a user's record to show the user's card. Here you can delete a user from Gameboard, change their approved name, add a disapproved reason, and even change their role.

Here you can also generate an API Key for the user.

1. Under API Keys, enter a name for your new API key.
2. Enter an expiration date or leave the date field blank for permanent access.
3. Click **Add**.
4. Click **Copy** to copy the new key and record it in safe place. You can only view it for a short period of time in the Gameboard.

## Adding Users

Administrators can create Gameboard user accounts in advance. Typically, users would register through an identity provider and their Gameboard account is generated at first login. Users select a sponsor and display name.

However, administrators can create Gameboard accounts proactively for users who already have an identity account. This is useful for events where pre-registered participants need to complete a specific set challenges or play in the Practice Area.

To add a new user in the Gameboard:

1. On the Users screen, click **Add Users**.
2. In the **Create Users** window, in the field, enter space- or line-delimited user GUIDs (globally unique identifiers) to create Gameboard user accounts. In this way, multiple accounts can be created at the same time. Example settings to configure initial user settings are provided.

Check failure on line 37 in docs/gameboard/admin-users.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/gameboard/admin-users.md#L37

[Vale.Spelling] Did you really mean 'GUIDs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'GUIDs'?", "location": {"path": "docs/gameboard/admin-users.md", "range": {"start": {"line": 37, "column": 86}}}, "severity": "ERROR"}
3. Under **Settings**, enable **Show an error if one of these IDs already exists** and/or **Don't force users to select their sponsor before playing** depending upon your needs.
4. Select a role to assign to the users.
5. Select a sponsor to assign to the users.
6. Select a game to enroll the users in.
7. Click **OK**. Gameboard creates the new users. If you sort the users in descending order by **Created On** date you'll see them at the top.
Loading

0 comments on commit 76e44e7

Please sign in to comment.