Skip to content

Commit

Permalink
Merge pull request #6 from sei-rlehman/archive-foundry-docs
Browse files Browse the repository at this point in the history
Adds deprecation banner to TopoMojo and Gameboard documentation pages
  • Loading branch information
sei-rreeder authored Nov 11, 2024
2 parents fd6c5bc + 318458a commit 740dfb1
Show file tree
Hide file tree
Showing 32 changed files with 1,602 additions and 1,506 deletions.
3 changes: 3 additions & 0 deletions docs/gameboard/admin-clone-yaml-json.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
!!! Warning ""

:warning: <strong>This documentation site has been deprecated and will no longer be updated as of 11/11/24. Foundry applications are now part of the [Crucible Framework](https://cmu-sei.github.io/crucible/). Please find current Gameboard documentation [here](https://cmu-sei.github.io/crucible/gameboard/).</strong>
# Clone, yaml, and json options

**Clone:** Creates a copy of the game that replicates most of the original game.
Expand Down
317 changes: 160 additions & 157 deletions docs/gameboard/admin-feedback-form.md

Large diffs are not rendered by default.

75 changes: 39 additions & 36 deletions docs/gameboard/admin-observe.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
# Observe Mode

Observe mode allows a game administrator with the correct role to see participant VMs during a particular game. Observers do not have the ability to interact with, or interfere with, the VM they are observing.

You must have either Observer Role or Admin Role to use Observe mode. Assuming you have been granted the appropriate role in the Gameboard, select **Admin**. Hover your mouse over an active board, then click **Observe**.

**Search:** The Search feature is relative to the screen you are viewing when performing the search. Searching on the Observe Challenges screen means you're searching that list of challenges for some criteria (name, challenge, tag, id). Searching on the Observe Players screen means you're searching that list of teams/players for some criteria (team name/player name, team id).

Gameboard talks to TopoMojo to launch challenges and to provide the Observe interface.

## Observe Challenges

**Observe Challenges** is a list of all challenges for all players in one table for that game. The console grid for this contains all VMs for a challenge --- whether active or not.

Under **Consoles**, select the grid icon to view active VMs in a grid view side-by-side according to player or team. Minimize and maximize the consoles within the grid as you observe. When the grid containing the consoles is open, the observe mode updates in real-time.

Selecting the four-square icon allows you to view the consoles of another player or team. Multiple observers can be on the same VM.

VM name (*win10-workstation*) and player display name (*Wolverine 3*) help observers identify the console they are viewing, especially if there are many players with many challenges. Click the **pop-out** icon to open the console in a new browser tab.

![observe-pop-out](img/observe-pop-out.png)

**Name:** Sort the consoles alphabetically by the Team/Player and then by challenge name.

**Rank:** Sort the consoles by scoreboard rank.

You can move a row to the top and "pin" it there to keep it in place. You can pin multiple rows at the top as well. This is useful when you are interested in following a certain few teams, players, or challenges. This is also useful after you have searched--you can pin results at the top where you can reference them frequently.

![observe-pin](img/observe-pin.png)

## Observe Players

**Observe Players** is a list of all players/teams for the game. The list of players/teams matches the entries on the scoreboard and contains "live" sessions; that is, sessions that are started. The console grid is one rectangle per user on a team. Users may not be on a VM at all yet or two users could be looking at the same VM.

In Observer mode, click the **Observe Players** link to follow a team or individual player.

!!! Warning ""

:warning: <strong>This documentation site has been deprecated and will no longer be updated as of 11/11/24. Foundry applications are now part of the [Crucible Framework](https://cmu-sei.github.io/crucible/). Please find current Gameboard documentation [here](https://cmu-sei.github.io/crucible/gameboard/).</strong>
# Observe Mode

Observe mode allows a game administrator with the correct role to see participant VMs during a particular game. Observers do not have the ability to interact with, or interfere with, the VM they are observing.

You must have either Observer Role or Admin Role to use Observe mode. Assuming you have been granted the appropriate role in the Gameboard, select **Admin**. Hover your mouse over an active board, then click **Observe**.

**Search:** The Search feature is relative to the screen you are viewing when performing the search. Searching on the Observe Challenges screen means you're searching that list of challenges for some criteria (name, challenge, tag, id). Searching on the Observe Players screen means you're searching that list of teams/players for some criteria (team name/player name, team id).

Gameboard talks to TopoMojo to launch challenges and to provide the Observe interface.

## Observe Challenges

**Observe Challenges** is a list of all challenges for all players in one table for that game. The console grid for this contains all VMs for a challenge --- whether active or not.

Under **Consoles**, select the grid icon to view active VMs in a grid view side-by-side according to player or team. Minimize and maximize the consoles within the grid as you observe. When the grid containing the consoles is open, the observe mode updates in real-time.

Selecting the four-square icon allows you to view the consoles of another player or team. Multiple observers can be on the same VM.

VM name (*win10-workstation*) and player display name (*Wolverine 3*) help observers identify the console they are viewing, especially if there are many players with many challenges. Click the **pop-out** icon to open the console in a new browser tab.

![observe-pop-out](img/observe-pop-out.png)

**Name:** Sort the consoles alphabetically by the Team/Player and then by challenge name.

**Rank:** Sort the consoles by scoreboard rank.

You can move a row to the top and "pin" it there to keep it in place. You can pin multiple rows at the top as well. This is useful when you are interested in following a certain few teams, players, or challenges. This is also useful after you have searched--you can pin results at the top where you can reference them frequently.

![observe-pin](img/observe-pin.png)

## Observe Players

**Observe Players** is a list of all players/teams for the game. The list of players/teams matches the entries on the scoreboard and contains "live" sessions; that is, sessions that are started. The console grid is one rectangle per user on a team. Users may not be on a VM at all yet or two users could be looking at the same VM.

In Observer mode, click the **Observe Players** link to follow a team or individual player.

Other than the differences described above Observe Players functions the same as Observe Challenges.
3 changes: 3 additions & 0 deletions docs/gameboard/admin-players.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
!!! Warning ""

:warning: <strong>This documentation site has been deprecated and will no longer be updated as of 11/11/24. Foundry applications are now part of the [Crucible Framework](https://cmu-sei.github.io/crucible/). Please find current Gameboard documentation [here](https://cmu-sei.github.io/crucible/gameboard/).</strong>
You must have the Admin Role to get to the Players screen in a game. Assuming you have been granted the appropriate role in the Gameboard, select **Admin**. Hover your mouse over an active game, then click **Players**.

**Search:** The Search feature is relative to the screen you are viewing when performing the search. You can apply the following filters to your search results and take action(s).
Expand Down
3 changes: 3 additions & 0 deletions docs/gameboard/admin-practice-area.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
!!! Warning ""

:warning: <strong>This documentation site has been deprecated and will no longer be updated as of 11/11/24. Foundry applications are now part of the [Crucible Framework](https://cmu-sei.github.io/crucible/). Please find current Gameboard documentation [here](https://cmu-sei.github.io/crucible/gameboard/).</strong>
# Admin Practice Area

Gameboard administrators configure the global Practice Area context here. In the main navigation bar, click **Admin**, then **Practice Area**.
Expand Down
133 changes: 68 additions & 65 deletions docs/gameboard/admin-roles.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,69 @@
# Gameboard Roles

The following is a list of roles in the gameboard. Note that these roles aren't additive -- they are independent. Therefore, each role has to be added individually and a single user can have multiple roles. Each assigned role only grants the privileges for that role. Roles do not inherit permissions from other roles.

## Gameboard privileges by role

The **Observer** role can:

- Observe consoles

The **Support** role can:

- Use the integrated support feature

The **Tester** role can:

- Enroll in games outside of the execution period
- Play games outside of the execution period
- View hidden games

The **Designer** role can:

- Create, edit, and delete games

The **Registrar** role can:

- Manage enrollment and registration

The **Director** role can:

- Observe consoles
- Use the integrated support feature
- Enroll in games outside of the execution period
- Play games outside of the execution period
- View hidden games
- Create, edit, and delete games
- Manage enrollment and registration
- *Cannot* assign or remove roles

The **Admin** role can:

- Observe consoles
- Use the integrated support feature
- Enroll in games outside of the execution period (see *Enroll vs. Admin Enroll* below)
- Play games outside of the execution period
- View hidden games
- Create, edit, and delete games
- Manage enrollment and registration
- Assign and remove roles
- Awards points manually to a player and team

## Enroll vs. Admin Enroll

After logging into Gameboard, but before playing a game or completing a lab users have to *enroll* in the game lobby. Users log into Gameboard, select a game on the **Home** page, and **Enroll** and **confirm** to start the session. The Enroll button appears when the user has set a display name and a sponsoring organization in their Profile and registration for that game is "open" (open and close dates and times are defined in the Admin Game Settings).

If a user is a *Registrar*, *Tester*, or *Admin*, then the **Admin Enroll** button appears next to the **Enroll** button. See the screen print below.

**Admin Enroll** allows a user with elevated roles to bypass the restrictions of time for registration, but it does *not* allow the user to bypass display name and sponsoring organization requirements. Those still need to be set prior to game play. **Admin Enroll** is useful for testing, troubleshooting, and customer support purposes.

!!! note

If you do have access to the **Admin Enroll** button, it behaves *identically* to the standard **Enroll** button for you. If you can see both **Enroll** and **Admin Enroll**, it does not matter which button you select.

*Enroll and Admin Enroll*

!!! Warning ""

:warning: <strong>This documentation site has been deprecated and will no longer be updated as of 11/11/24. Foundry applications are now part of the [Crucible Framework](https://cmu-sei.github.io/crucible/). Please find current Gameboard documentation [here](https://cmu-sei.github.io/crucible/gameboard/).</strong>
# Gameboard Roles

The following is a list of roles in the gameboard. Note that these roles aren't additive -- they are independent. Therefore, each role has to be added individually and a single user can have multiple roles. Each assigned role only grants the privileges for that role. Roles do not inherit permissions from other roles.

## Gameboard privileges by role

The **Observer** role can:

- Observe consoles

The **Support** role can:

- Use the integrated support feature

The **Tester** role can:

- Enroll in games outside of the execution period
- Play games outside of the execution period
- View hidden games

The **Designer** role can:

- Create, edit, and delete games

The **Registrar** role can:

- Manage enrollment and registration

The **Director** role can:

- Observe consoles
- Use the integrated support feature
- Enroll in games outside of the execution period
- Play games outside of the execution period
- View hidden games
- Create, edit, and delete games
- Manage enrollment and registration
- *Cannot* assign or remove roles

The **Admin** role can:

- Observe consoles
- Use the integrated support feature
- Enroll in games outside of the execution period (see *Enroll vs. Admin Enroll* below)
- Play games outside of the execution period
- View hidden games
- Create, edit, and delete games
- Manage enrollment and registration
- Assign and remove roles
- Awards points manually to a player and team

## Enroll vs. Admin Enroll

After logging into Gameboard, but before playing a game or completing a lab users have to *enroll* in the game lobby. Users log into Gameboard, select a game on the **Home** page, and **Enroll** and **confirm** to start the session. The Enroll button appears when the user has set a display name and a sponsoring organization in their Profile and registration for that game is "open" (open and close dates and times are defined in the Admin Game Settings).

If a user is a *Registrar*, *Tester*, or *Admin*, then the **Admin Enroll** button appears next to the **Enroll** button. See the screen print below.

**Admin Enroll** allows a user with elevated roles to bypass the restrictions of time for registration, but it does *not* allow the user to bypass display name and sponsoring organization requirements. Those still need to be set prior to game play. **Admin Enroll** is useful for testing, troubleshooting, and customer support purposes.

!!! note

If you do have access to the **Admin Enroll** button, it behaves *identically* to the standard **Enroll** button for you. If you can see both **Enroll** and **Admin Enroll**, it does not matter which button you select.

*Enroll and Admin Enroll*

![enroll vs. admin enroll](img/enroll-admin-enroll.png)
Loading

0 comments on commit 740dfb1

Please sign in to comment.