Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

My changes exported from my codespace #92

Merged
merged 1 commit into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"cSpell.words": [
"Gameboard",
"markdownguide",
"Unsubmitted",
"wwwroot"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Game participants can view, share, and print certificates of completion as proof of participation in a game. To do so, certificate templates must be configured in a game's Metadata settings. Game organizers (i.e., users who have been granted a role with the appropriate permissions) configure certificate templates to customize the appearance of these completion certificates.

To create a *certificate template*, you must have the *Administrator* role in the Gameboard. For more information about roles, please see the [Gameboard Roles Guide](C:\Users\rgreeder\OneDrive - Software Engineering Institute\Desktop\Gameboard-docs).
This topic assumes you have been granted a role with the appropriate permissions in Gameboard, you are logged in, and you have a game created.
Game participants can view, share, and print certificates of completion as proof of participation in a game. To do so, certificate templates must be configured in a game's Metadata settings. Game organizers (i.e., users who have been granted a role with the appropriate permissions) configure certificate templates to customize the appearance of these completion certificates.

This topic assumes you have been granted a role with the appropriate permissions in Gameboard, you are logged in, and you have a game created.

1. In the top navigation, select **Admin**.
Expand Down
2 changes: 1 addition & 1 deletion docs/gameboard/admin-feedback-form.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Feedback Form
# Configuring feedback templates

In the Gameboard application, it is possible to create feedback forms to capture participant feedback on the game and individual challenges. Collecting and analyzing participant feedback can help you refine and improve your games and challenges.

Expand Down
6 changes: 4 additions & 2 deletions docs/gameboard/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ In the Announcement field, enter the content of the announcement and click **Ann

The **Games** tab is the landing page when you select **Admin** from the top navigation menu. By default, the games are displayed as cards.

### The Game Center

Select a game card to access that game in the **Game Center**. The Game Center is the one-stop-shop where games are configured, managed, and observed. See the [Game Center documentation](game-center.md) for a full explanation of the Game Center.

Note the **game info icons** at the bottom of the game cards. When hovered over, these icons provide information about the game.
Expand Down Expand Up @@ -80,6 +82,6 @@ Deleting a game deletes it from the Gameboard app.

1. On the game card, select the **3 dot context** menu, then **Delete**.

!!! note
!!! warning

Games can't be deleted if they contain registered users.
Games that contain registered players *can* be deleted by users who have the appropriate role permission (i.e., Admin and Director).
16 changes: 10 additions & 6 deletions docs/gameboard/game-center.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Game Center [BETA]
# Game Center

The **Game Center** is the game administrator's one stop shop when administering a live game. The Game Center unifies various Gameboard administrative and support elements such as game and challenge settings, player information, live sessions, support tickets, observe mode, and more.

Expand Down Expand Up @@ -40,13 +40,17 @@ In the Game Center header, game metadata and settings information is displayed,

**Lobby Markdown:** Using Markdown enter any information you would like players to see when they enter the game lobby. For help with Markdown syntax, see this [Markdown Guide](https://www.markdownguide.org/).

**Feedback Questions:** It's possible -- but not required -- to create questions to capture participant feedback on the game and individual challenges. Create your feedback questions here using YAML. For help with the feedback feature, see the [Feedback Form documentation](admin-feedback-form.md).
#### Player Feedback

**About feedback templates:** This modal provides instructions for configuring questions presented to players after they complete a challenge or game.
It's possible (but not required) to create questions to capture participant feedback on games and challenges. Create your feedback form template here.

**Paste Example Configuration:** Pastes sample feedback configuration into the Feedback Questions field for you to modify and use for your own needs.
For a full treatment of Gameboard's feedback feature, please see the [Configuring feedback templates](admin-feedback-form.md) section of the docs.

**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.
#### Completion Certificates

It's possible (again, not required) to design certificate of completion templates so participants can view, share, and print certificates as proof of their participation in a game.

For a full treatment of how to design completion certificates, please see the [Configuring certificate templates](admin-completion-certificates.md) section of the docs.

### Modes

Expand Down Expand Up @@ -168,4 +172,4 @@ The support ticketing functionality found here is the same as the interface docu

## Scoreboard tab

The scoreboard found here is the same scoreboard you would find if you clicked the Scoreboard link in a game lobby.
The scoreboard found here is the same scoreboard you would find if you clicked the Scoreboard link in a game lobby.
8 changes: 4 additions & 4 deletions docs/gameboard/player-feedback-form.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Giving feedback as a player
# Giving feedback as a player

Provided that a Gameboard administrator has enabled and configured the *feedback* feature, players are permitted **one** feedback submission per game and/or per challenge. Every member of a team is permitted to provide individual feedback. The feedback form is available at any time after a session has started. This way, if participants quit the game before time expires they still have the opportunity to submit feedback.

*The screen print below shows an example of a **challenge** feedback form as a player would see it.*
The screen print below shows an example of a **challenge** feedback form as a player would see it.

![challenge form](img/challenge-feedback.png)

Expand All @@ -13,12 +13,12 @@ Unsubmitted feedback and submitted feedback can be viewed in the reports. Once f
This documentation assumes the player is logged into a game and successfully enrolled. To view the *game* feedback as a participant:

1. From the game lobby, select **Start Session**, then click through the confirmations to start the session.
2. Scroll down to the Feedback form and complete the survey.
2. Scroll down to the Feedback form and complete the survey.
3. Click **Submit**, then **Confirm** when finished. Responses can't be edited after clicking **Submit**. Game feedback responses do auto-save.

To view the *challenge* feedback as a participant:

1. From the game lobby, select **Start Session**, then click through the confirmations to start the session.
2. Select **Continue to Gameboard** and start a challenge.
3. Scroll down to the Feedback form and complete the survey.
4. Click **Submit**, then **Confirm** when finished. Responses can't be edited after clicking **Submit**. Challenge feedback responses do auto-save.
4. Click **Submit**, then **Confirm** when finished. Responses can't be edited after clicking **Submit**. Challenge feedback responses do auto-save.
5 changes: 3 additions & 2 deletions docs/gameboard/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The new name entered on the certificate is temporary and *only for printing purp

### Creating certificate templates

Game organizers with the appropriate role/permissions create completion certificate templates in the game Metadata settings. See [Configuring certificate templates](completion-certificates.md) in the *Administering games* section of the Gameboard docs.
Game organizers with the appropriate role/permissions create completion certificate templates in the game Metadata settings. See [Configuring certificate templates](admin-completion-certificates.md) in the *Administering games* section of the Gameboard docs.

## History tab

Expand All @@ -61,4 +61,5 @@ Users granted a role with the appropriate permissions can view the **Settings ta

!!! note

Browser notifications are subject to OS-level settings which may need to be changed and browser site settings for pop-ups and redirects which need to be allowed.
Browser notifications are subject to OS-level settings which may need to be changed and browser site settings for pop-ups and redirects which need to be allowed.

4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ nav:
- Players: gameboard/admin-players.md
- Observe mode: gameboard/admin-observe.md
- Settings: gameboard/admin-settings.md
- Feedback form: gameboard/admin-feedback-form.md
- Configuring Certificate Templates: gameboard/completion-certificates.md
- Configuring Player Feedback Templates: gameboard/admin-feedback-form.md
- Configuring Certificate Templates: gameboard/admin-completion-certificates.md
- Blueprint: blueprint/index.md
- CITE: cite/index.md
- Gallery: gallery/index.md
Expand Down