Skip to content

Commit

Permalink
Merge pull request #303 from NationalSecurityAgency/t#302/document_3_3
Browse files Browse the repository at this point in the history
T#302/document 3 3
  • Loading branch information
dwalizer authored Jan 14, 2025
2 parents 3d60dfb + 62caa46 commit 0b89c7d
Show file tree
Hide file tree
Showing 15 changed files with 187 additions and 30 deletions.
15 changes: 14 additions & 1 deletion cypress/e2e/admin.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ context('Admin: Generate Screenshots', () => {
cy.snap('component-user_progress_table', '#mainContent2');
})

it('Users Archive component', () => {
// projects page
cy.visit('/administrator/projects/movies/users')
cy.get('[data-cy="usersTable"] [data-p-index="0"] [data-pc-name="rowcheckbox"]').click()
cy.get('[data-cy="usersTable"] [data-p-index="1"] [data-pc-name="rowcheckbox"]').click()
cy.snap('component-users_table_ready_to_archive', '#mainContent2');
cy.get('[data-cy="archiveUsersTableBtn"]').click()

cy.get('[data-cy="userArchiveBtn"]').click()
cy.get('[data-cy="userArchiveTable"] [data-cy="skillsBTableTotalRows"]').should('have.text', '2')
cy.snap('component-users_archive', '#mainContent2');
})

it('Gen Projects pages - dark mode', () => {
cy.request('POST', '/app/userInfo/settings', [{
'settingGroup': 'user.prefs',
Expand Down Expand Up @@ -215,8 +228,8 @@ context('Admin: Generate Screenshots', () => {
it('Settings Page', () => {
cy.visit('/administrator/projects/movies/settings')
cy.contains('Discoverable');
cy.get('[data-cy="customLabelsSwitch"]').click();
cy.snap('page-project-settings');
cy.snap('component-project-settings', '#mainContent2');
})

it('Email notification pages', () => {
Expand Down
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ console.log(`Sidebar object:\n${JSON.stringify(sidebar, null, 2)}`);

export default defineUserConfig({
bundler: viteBundler(),
port: 9999,
lang: 'en-US',
description: 'Innovative approach to application training!',
head: [
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/user-guide/progress-and-ranking.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ A single quiz or survey attempt will display the results of that attempt. In the

In the case of a quiz, there are a number of possible conditions based on the status of the attempt:
- `Passed` Quiz: all the questions and answers are shown
- `Failed` Quiz: by default only manually graded (`Text Input`) answers are shown, `Single Choice` and `Multiple Choice` answers are not displayed; however if [Show Correct Answers On Failure](/dashboard/user-guide/quizzes-and-surveys.html#quiz-settings) setting is enabled then all the answers are displayed
- `Failed` Quiz: by default only manually graded (`Text Input`) answers are shown, `Multiple Answers` and `Multiple Choice` questions are not displayed; however if [Show Correct Answers On Failure](/dashboard/user-guide/quizzes-and-surveys.html#quiz-settings) setting is enabled then all the answers are displayed
- `Needs Grading` Quiz: answers are not displayed

## Badges Page
Expand Down
66 changes: 65 additions & 1 deletion docs/dashboard/user-guide/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The Dashboard user that creates a project is automatically granted the role of a

To manage and view project-wide settings navigate to ``Project -> Settings``.

![Project Settings](../../screenshots/admin/page-project-settings.png)
![component-project-settings.png](../../screenshots/admin/component-project-settings.png)

The following project-level settings are available:

Expand Down Expand Up @@ -130,6 +130,20 @@ If this is the case, admins can customize the following labels displayed to user

Toggle this setting to always show the group's descriptions in this project embedded Skills Display component and Progress and Ranking pages.

### Setting: Hide Group Info On Skill Pages <since project="skills-service" version="3.3" />

By default, the skill page displays the group name and description when a skill is part of a Skill Group. Enabling this
setting will hide the group's information from the skill page.

### Setting: Hide Achievement Celebration <since project="skills-service" version="3.3" />

Trainee achievement celebrations are displayed throughout training displays when levels, badges, and skills are
achieved. These congratulatory messages can be hidden by enabling the `Hide Achievement Celebration` setting.

### Setting: Project Deletion Protection <since project="skills-service" version="3.3" />

When this setting is enabled, project deletion will be prevented, and the Delete button will be hidden.

## Access
The Project Access page supports adding or removing Project Administrators, Project Approvers, and inviting users to join a project if the project has been configured as an Invite Only project as well as revoking a user's access.

Expand Down Expand Up @@ -223,6 +237,56 @@ The following training profile elements are **NOT** copied into a new project:
Once a project has been copied, the new project is disconnected from the original such that changes to the original project will not be reflected in the copy
:::

## Copy Subject to Another Project <since project="skills-service" version="3.3" />

A subject in its entirety can be easily copied from one project to another. To do this, navigate to the Subject page and
click the `Copy` button located on the top-left of the screen, right below the subject's name. Once the copy operation
is initiated, you will be guided through the destination project selection.

The following subject's training profile elements are copied:
- Subject's attributes (icon, description, help URL)
- Skills definitions and their attributes (description, points, self-reporting, etc.)
- Skill Groups
- Configured display order of subject's skills

::: tip
After copying a subject, the new subject becomes independent of the original, and any changes made to the original
subject will not affect the copied subject
:::

The following elements are excluded from the subject copying process:
- Reused skills
- Imported catalog skills
- Levels: destination project's subject will be created with default level configuration
- Cross-project prerequisites

::: warning
When copying a subject to another project, the destination project must meet the following requirements:

* It must not have an existing subject with the same name or ID.
* It must not have any skills with IDs or names that match the copied subject's skills.
:::

## Copy Skills to Another Project <since project="skills-service" version="3.3" />

Skills can be copied individually or in batches from one project to another. To do so:

* Navigate to the Subject page
* Select one or more skills
* Click the Actions drop-down button at the top-right of the skills' table
* Select "Copy to another Project"

Once the copy operation is initiated, you will be guided through the process of selecting a destination project and subject or skill group.

::: tip
After copying skills, the new skills become independent of the originals, and any changes made to the originals will not affect the copied skills.
:::

::: warning
Note that the destination project must not have any subjects, badges, or skills with IDs or names that match the copied skills.
:::


## Share Project

Public projects that are configured to be [discoverable](/dashboard/user-guide/projects.html#setting-visibility) can be easily shared with users so they can begin consuming the micro-learning gamified training!
Expand Down
16 changes: 5 additions & 11 deletions docs/dashboard/user-guide/quizzes-and-surveys.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ or can be executed independently. Associating a Quiz to an existing skill will r
in order to earn the skill and its points. In the case of a quiz, then the quiz serves as the skill's knowledge check.

Quizzes currently support two types of questions:
- ``Single Choice`` - question will only have 1 correct answer
- ``Mulitple Choice`` - question has 2 or more correct choices; all correct choices must be selected to get credit for the question
- ``Multiple Choice`` - question will only have 1 correct answer
- ``Multiple Answers`` - question has 2 or more correct choices; all correct choices must be selected to get credit for the question
- ``Input Text`` - question for test-takers to provide a free-form text answer that will later be graded by a quiz administrator

To administer a quiz click `Manage` button for that quiz on the `Quizzes and Surveys` page.
Expand All @@ -59,12 +59,6 @@ To add a new question please click `Question +` button.

The Question's text supports all the same features that the [Description Editor](/dashboard/user-guide/rich-text-editor.html) currently affords which
includes a generous feature set including attaching or copy-and-pasting screenshots.
The two supported question's types and ``Single Choice`` and ``Mulitple Choice`` and are implicitly derived from the number of the selected correct answers.
A single selected correct answer implies ``Single Choice`` question type and when more than one corrected answers selected then ``Mulitple Choice`` is used.
::: tip
When multiple correct answers are selected users will be required to properly identify all of those correct answers in
order to receive the credit for the question
:::

::: tip
Use the `Preview` button on the top left below the Quiz name in order to see what the quiz will look like to your users.
Expand Down Expand Up @@ -148,8 +142,8 @@ When associated to a skill, the survey is a method to gather feedback about that
pieces of important data related to the skill.

A Survey currently supports four types of questions:
- ``Single Choice`` - question will only allow a single choice to be selected
- ``Mulitple Choice`` - one or more choices are required to be selected
- ``Multiple Choice`` - question will only allow a single choice to be selected
- ``Multiple Answers`` - one or more choices are required to be selected
- ``Text Input`` - a freeform answer text is required
- ``Rating`` - a star-based rating question with an ability configure between 3 and 10 stars

Expand All @@ -163,7 +157,7 @@ To add a new question please click the `Question +` button.

The Question's text supports all the same features that the [Description Editor](/dashboard/user-guide/rich-text-editor.html) currently affords which
includes a generous feature set including attaching or copy-and-pasting screenshots.
Please use the Answer's dropdown to select the type, currently available options are ``Single Choice``, ``Mulitple Choice`` and ``Text Input``.
Please use the Answer's dropdown to select the type.

::: tip
Use the `Preview` button on the top left below the Survey name in order to see what the survey will look like to your users.
Expand Down
8 changes: 8 additions & 0 deletions docs/dashboard/user-guide/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ When captions are configured the video player will present an option to turn cap
Captions utilize [Web Video Text Tracks Format (WebVTT)](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API) format
and its input form offers an ability to prefill an example in WebVTT format by clicking `Add Example` button above the `Captions` input field.

::: tip
Configure the video size by dragging the button on the bottom-right corner of the video. After resizing, click the
**Save Changes** button to persist the new dimensions.

Trainees can also resize videos, and their personalized configurations will be automatically saved in the browser's
local storage and will take priority over the default.
:::

### Achieve Skill By Watching the Video

Once the video's settings are specified the skill can also be configured to be achieved after the trainee watched the entire video (>96%).
Expand Down
19 changes: 19 additions & 0 deletions docs/dashboard/user-guide/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,25 @@ Additionally, you can export the table data into an Excel file by clicking the E
Note that the export will respect any currently applied filters.
:::

## Users Archive <since project="skills-service" version="3.3" />

Users can be archived and restored in batches or individually. Archived users are excluded from project visualizations, metrics, and tables.

To archive a user, follow these steps:

- Navigate to the Users page under a project.
- Select one or more users in the users table.
- Click the Archive button.

![component-users_table_ready_to_archive.png](../../screenshots/admin/component-users_table_ready_to_archive.png)

The archive can be viewed by clicking the `User Archive` button, located on the top-right, above the users table's components.

![component-users_archive.png](../../screenshots/admin/component-users_archive.png)

To restore an archived user, simply click the `Restore` button for that user.


## User Roles

### Default User
Expand Down
43 changes: 42 additions & 1 deletion docs/release-notes/skills-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,50 @@ To obtain deployable artifacts please visit [Distributions](/dashboard/install-g

</conditional>

## 3.3.0 <release-date date="January 2025" />
- Ability to [archive and restore users](/dashboard/user-guide/users.html#users-archive) in batch or individually, with archived users excluded from project visualizations, metrics, and tables
- Ability to copy training profile components between projects
- [Batch skill definition copying](/dashboard/user-guide/projects.html#copy-skills-to-another-project) from one project to another
- [Copying subject definitions](/dashboard/user-guide/projects.html#copy-subject-to-another-project), including all skills, from one project to another
- Trainee achievement celebrations with congratulatory messages displayed throughout training displays when levels, badges, and skills are achieved
- Added [project configuration option](/dashboard/user-guide/projects.html#setting-hide-achievement-celebration) to disable achievement celebrations
- Enhanced Project Deletion Protection
- Clear warning of permanent removal of users and definitions
- Requirement for multiple administrator acknowledgments before removal
- New project setting: [Project Deletion Protection](/dashboard/user-guide/projects.html#setting-project-deletion-protection) to prevent deletion when enabled
- Introduced "Points First Earned" column on users table for project, subject, skill, and badge administrative pages
- Self Reported skills enhancements
- Feedback provision to users when approving self-reported skills
- Historical display of self-reporting requests and responses
- Trainee access to submitted justification for self-reported skills
- Skills Group usage improvements
- Enhanced skill page display with group name and description
- Group name/description display can be [disabled/enabled by project administrators](/dashboard/user-guide/projects.html#setting-hide-group-info-on-skill-pages)
- Ability to collapse and expand all Skills Groups, with expansion state persisted in browser local storage
- Embedded video resizing
- Administrator configuration of default [video](/dashboard/user-guide/skills.html#videos) size
- Trainees can resize videos, and their personalized configurations are automatically persisted in the browser's local storage
- Enhanced the [result object](/skills-client/endpoints.html#endpoint-result-object) returned by the [Report Skill Endpoint](/skills-client/endpoints.html#report-skill-event-endpoint) to include information about the earned and available points for the skill.
- Improved terminology for Quiz and Survey Choice questions


## 3.2.5 <release-date date="December 2024" />
- Spring Boot Upgrade

## 3.2.4 <release-date date="December 2024" />
- Bug Fixes

## 3.2.3 <release-date date="December 2024" />
- Bug Fixes

## 3.2.2 <release-date date="November 2024" />
- Spring Boot Upgrade

## 3.2.1 <release-date date="November 2024" />
- Bug Fixes

## 3.2.0 <release-date date="November 2024" />
- Introduced the ability to manage project and quiz administrators in [groups](/dashboard/user-guide/admin-groups.html.
- Introduced the ability to manage project and quiz administrators in [groups](/dashboard/user-guide/admin-groups.html).
- The new approach allows for simple creation and management of Admin Groups.
- Admin groups can easily be assigned to multiple projects and/or quizzes.
- Introduced a brand-new quiz question type: `Input Text` with a comprehensive grading mechanism.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/admin/component-user_progress_table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/admin/modal-new-question.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0b89c7d

Please sign in to comment.