Skip to content
Merged

3.7.x #319

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
2 changes: 1 addition & 1 deletion cypress/e2e/admin-quiz_and_surveys.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ context('Admin: Generate Quiz and Surveys Screenshots', () => {
cy.visit('/administrator/quizzes/ShortScienceQuiz')
cy.get('[data-cy="editQuestionButton_1"]')
cy.get('[data-cy="btn_Questions"]').click()
cy.get('[data-cy="discardContentButton"]').click({force: true})
// cy.get('[data-cy="discardContentButton"]').click({force: true})
cy.get('[data-cy="answer-0"] [data-cy="selectCorrectAnswer"]').click()
cy.get('[data-cy="answer-1"] [data-cy="selectCorrectAnswer"]').click()
cy.get('[data-cy="answer-0"] [data-cy="answerText"]').type('Blue')
Expand Down
15 changes: 13 additions & 2 deletions cypress/e2e/admin.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ context('Admin: Generate Screenshots', () => {
cy.visit('/administrator/projects/movies/subjects/Action/');
cy.get('[data-cy="newSkillButton"]').click();
cy.get('[data-pc-name="pcmaximizebutton"]').click()
cy.get('[data-cy="discardContentButton"]').click({force: true})
cy.wait(1000)
cy.get('[data-cy="skillName"]').clear()
cy.get('[data-cy="skillName"]').type('Test Skill')
Expand All @@ -117,7 +116,7 @@ context('Admin: Generate Screenshots', () => {
cy.snap('modal-skills-new_skill', '.p-dialog')
})

it('Gen Self Report page', () => {
it.only('Gen Self Report page', () => {
cy.viewport(1350, 1200);

cy.visit('/administrator/projects/movies/badges')
Expand Down Expand Up @@ -659,4 +658,16 @@ context('Admin: Generate Screenshots', () => {

})

it('Notifications', () => {
cy.viewport(1000, 900);
cy.visit('/administrator/');
cy.get('[data-cy="notifBtn"]')

cy.snap('component-notifications-btn', null, {clip: { x: 800, y: 0, width: 200, height: 100 }});

cy.get('[data-cy="notifBtn"]').click()
cy.get('[data-cy="notifPanel"] [data-cy="notif-0"]')
cy.snap('component-notifications-dropdown', null, {clip: { x: 370, y: 0, width: 540, height: 550 }});
});

})
7 changes: 7 additions & 0 deletions cypress/e2e/progress-and-ranking.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -192,5 +192,12 @@ context('Progress and Ranking: Generate Screenshots', () => {
cy.snap('page-my-quiz-single-attempt');
})

it('training wide search modal', () => {
cy.visit('/progress-and-rankings/projects/shows')
cy.get('[data-cy="skillsDisplaySearchBtn"]').click()
cy.get('[data-cy="trainingSearchDialog"]').should('be.visible')

cy.snap('component-training-wide-search', '[data-cy="trainingSearchDialog"]');
})

})
12 changes: 6 additions & 6 deletions docs/.vuepress/components/ReleaseDate.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ defineProps(['date'])
</script>

<template>
<span class="date">
<span class="badge bg-secondary release-date">📆 {{ date }}</span>
</span>
<div class="badge bg-secondary release-date"><i>Release Month:</i> <span class="date">📆 {{ date }}</span></div>
</template>

<style scoped>
.date {
font-size: 1rem;
color: #915930;
background-color: #faf2da;
padding: 0.2rem 0.8rem;
color: #c2410c;
background-color: #ffedd5;
padding: 0.2rem 0.5rem;
border-radius: 10px;
margin-top: 0.5rem;
}
.release-date {
font-size: 1rem;
margin-top: 0.5rem;
}
</style>
2 changes: 2 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ sidebar = sidebar.concat([{
'/dashboard/user-guide/levels',
'/dashboard/user-guide/users',
'/dashboard/user-guide/metrics',
'/dashboard/user-guide/notifications',
'/dashboard/user-guide/inception',
'/dashboard/user-guide/contact-admins',
'/dashboard/user-guide/settings',
Expand Down Expand Up @@ -166,6 +167,7 @@ sidebar = sidebar.concat([{
}, {
text: 'Release Notes',
collapsible: true,
sidebarDepth: 3,
children: [
'/release-notes/',
'/release-notes/skills-service.md',
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/install-guide/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ skills.config.ui.docsHost=https://code.nsa.gov/skills-docs

### SkillTree Support

#### Support Center <since project="skills-service" version="3.6" />
#### Support Center

When enabled, the Help button in the header dropdown includes a page-aware contact link. The contact action varies based
on the current page:
Expand Down
15 changes: 15 additions & 0 deletions docs/dashboard/user-guide/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Notifications

Unobtrusive alerts are displayed via the drop-down in the top right corner of the dashboard. These notifications
are time-based, non-intrusive, and easily dismissed.

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

Clicking the alert drop-down will display the notifications.

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

A single notification can be dismissed by clicking the "Dismiss" button next to it. All notifications can be dismissed
by clicking the "Dismiss All" button. Once notifications are dismissed, they will no longer appear on the dashboard.

Current alerts notify users about new SkillTree releases and features. Additional notification types may be added in the future.
19 changes: 11 additions & 8 deletions docs/dashboard/user-guide/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,23 +289,26 @@ Note that the destination project must not have any subjects, badges, or 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!
Projects can be easily shared with users so they can begin taking the micro-learning gamified training.

To share a project click on the ``Share`` button on the project admin page:
To share a project, click on the **Share** button on the project admin page:

![SkillTree Project](../../screenshots/admin/page-partial-share-proj.png)

Once the ``Share`` button is clicked the share information modal is displayed:
Once the **Share** button is clicked, the share information modal is displayed:

![SkillTree Project Shared Modal](../../screenshots/admin/modal-share_proj.png)
![SkillTree Project Share Modal](../../screenshots/admin/modal-share_proj.png)

Copy the url and share it with your trainees.
When the link is visited, two things happen:
Copy the URL and share it with your trainees. When the link is visited, two things happen:
- The Progress and Ranking page for that project is displayed *AND*
- the project is automatically added to [My Projects](/dashboard/user-guide/progress-and-ranking.html#progress-and-ranking-my-projects).
- The project is automatically added to [My Projects](/dashboard/user-guide/progress-and-ranking.html#progress-and-ranking-my-projects).

::: tip Important
Please note that once users click on the shared links, this project will appear in that user's [Project Catalog](/dashboard/user-guide/progress-and-ranking.html#projects-catalog) even if the project's [Discoverability](/dashboard/user-guide/projects.html#setting-project-discoverability) settings are set to "Not in the Project Catalog".
:::

::: warning Important
The ``Share`` button is only displayed if the [Project Discoverability](/dashboard/user-guide/projects.html#setting-project-discoverability) is configured to the ``Add to Project Catalog`` option.
The **Share** capability is only available if the project was **not** configured to use the "Private Invite Only" authorization mechanism.
:::

## Activity History
Expand Down
21 changes: 13 additions & 8 deletions docs/dashboard/user-guide/quizzes-and-surveys.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ includes a generous feature set including attaching or copy-and-pasting screensh
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.
:::

### Answer Hints <since project="skills-service" version="3.5" />
### Answer Hints

When creating a question, quiz administrators can configure helpful answer hints, which are displayed next to the
question during the quiz. To enter a hint, create a new question or edit an existing one and click the
Expand All @@ -76,7 +76,7 @@ Additionally, administrators can enable the [Only Show Hints on Retake Attempts]
will only display answer hints on subsequent quiz retakes after the first attempt was unsuccessful.
To enable or disable this option, navigate to the Quiz's Settings page.

### Audio/Video for Quiz <since project="skills-service" version="3.6" />
### Audio/Video for Quiz

SkillTree supports embedding video or audio clips into quiz questions, which will be available for playback during the quiz.

Expand Down Expand Up @@ -168,16 +168,16 @@ accurately tracks each successful attempt, providing a comprehensive view of use
Enabling this feature will provide the correct answers on failed quiz attempts, allowing users to review and understand
the correct answers, improving their learning and understanding of the material.

#### Setting: Limit Retake to Incorrect Questions <since project="skills-service" version="3.4" />
#### Setting: Limit Retake to Incorrect Questions

Enabling this feature limits the questions presented to users when retaking a quiz to those that were answered
incorrectly on the previous attempt.

#### Setting: Only Show Hints on Retake Attempts <since project="skills-service" version="3.5" />
#### Setting: Only Show Hints on Retake Attempts

Enabling this feature will only display answer hints on subsequent quiz retakes after the first attempt was unsuccessful.

#### Setting: Display Quiz Description During Quiz <since project="skills-service" version="3.5" />
#### Setting: Display Quiz Description During Quiz

Enabling this feature will display the quiz description while the quiz is being taken.

Expand Down Expand Up @@ -211,7 +211,7 @@ Please use the Answer's dropdown to select the type.
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.
:::

### Audio/Video for Survey <since project="skills-service" version="3.6" />
### Audio/Video for Survey

SkillTree supports embedding video or audio clips into survey questions, which will be available for playback during the survey.

Expand Down Expand Up @@ -265,15 +265,20 @@ The page features
- in the case of quizzes, a bar chart breakdown for each question depicting the difference between the correct and the wrong question attempts
- number of times each answer was selected and its associated selection percentage
- for each answer, an ability to drill down to its history
- Date range filter

::: tip
::: tip Filter
Quiz results can be filtered by completion date range. To filter results, click the date range input in the top right
corner of the quiz results page and click the "Apply" button.
:::

::: warning Good to know
Please note that only the completed quizzes/surveys are shown on this page, if you are looking for `In Progress`
runs please visit [Runs](/dashboard/user-guide/quizzes-and-surveys.html#runs) page.
:::

![Quiz Results Page Screenshot](../../screenshots/admin/page-quiz-results.png)


## Runs
To track individual quiz/survey runs please visit the Runs page (``Quizzes and Surveys -> Quiz/Survey -> Results ``). Each row represents a single Quiz/Survey for a single user.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/user-guide/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Ability to customize your personal user preference, including:
- Default Home/Landing Page
- Ability to opt-out from Ranking and Leaderboards
- Enabling and/or disabling UI Dark Mode
- Customize keyboard shortcuts for training navigation
- Customize keyboard shortcuts for training navigation and search

![User Preferences](../../screenshots/admin/page-settings-preference.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/user-guide/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To calculate the total points that completion of a particular skill will give a
Total Points = Point Increment * Occurrences to Completion
:::

## Skill Creation Lifecycle <since project="skills-service" version="3.6" />
## Skill Creation Lifecycle

Skills can be created with their Initial Visibility set to ``Hidden``. When hidden, skills
remain invisible to trainees until the ``Initial Visibility`` is switched to ``Visible``. This feature allows you to
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/user-guide/subjects.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To create a Subject navigate to ``Project -> Subjects`` and then click the ``Sub
To navigate to a specific skill you can drill down into a subject card or use the ``Search and Navigate directly to a skill`` component
:::

## Subject Creation Lifecycle <since project="skills-service" version="3.6" />
## Subject Creation Lifecycle

Subjects can be created with their Initial Visibility set to ``Hidden``. When hidden, both the subject and its skills
remain invisible to trainees until the ``Initial Visibility`` is switched to ``Visible``. This feature allows you to
Expand Down
14 changes: 6 additions & 8 deletions docs/dashboard/user-guide/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,18 @@ Please note that a user has to earn at least 1 point in order to show up in on t
:::

### Filters, Sorting And Export
The User Progress Table offers filtering and sorting capabilities to help you analyze user performance. You can:
The User Progress Table offers filtering, sorting, and export capabilities to help you analyze user performance. You can:

- Filter by user ID, first name, and last name using the User Filter.
- Filter by the minimum user progress using the Minimum User Progress filter.

You can also sort the table by any of the columns by clicking on the column header.

Additionally, you can export the table data into an Excel file by clicking the Export button located on the top right of the table.
- Filter by user ID, first name, and last name using the User Filter
- Filter by minimum and maximum user progress percentage using the User Progress filter
- Sort any column by clicking its header
- Export table data to Excel by clicking the Export button in the top right

::: tip
Note that the export will respect any currently applied filters.
:::

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

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

Expand Down
33 changes: 22 additions & 11 deletions docs/release-notes/skills-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,52 +23,63 @@ This approach ensures that integrators can rely on a stable and consistent libra
ongoing evolution of the SkillTree Platform.
:::

## 3.6.0 <release-date date="Oct. 2024" />
## 3.6.0
<release-date date="Oct. 2024" />
- Added the ability to place the skills-client library in a dormant state. When the library is in a dormant state, it
becomes inactive and does not perform authentication, network communication, skill reporting, or any other activities.
- Upgraded JS libraries
- Bug Fixes

## 3.5.0 <release-date date="Sep. 2022" />
## 3.5.0
<release-date date="Sep. 2022" />
- Ensure that skills-client react libraries work with React 18
- Removed history package dependency
- Addressed 3rd party library security vulnerabilities
- Allowed options to be passed to the Skills Display component for future configuration options
- Added ability to respond to scroll events from the Skills Display component

## 3.4.1 <release-date date="Dec. 2021" />
## 3.4.1
<release-date date="Dec. 2021" />
- Detect when the web-socket connection errors, and if the message indicates an invalid_token, then obtain a new token and reconnect

## 3.4.0 <release-date date="Nov. 2021" />
## 3.4.0
<release-date date="Nov. 2021" />
- Ensure that skills-client react libraries work with React 17

## 3.3.1 <release-date date="Jul. 2021" />
## 3.3.1
<release-date date="Jul. 2021" />
- Implemented (``navigate``) method for programmatic navigation in the ``SkillsDisplay`` component

## 3.3.0 <release-date date="Jun. 2021" />
## 3.3.0
<release-date date="Jun. 2021" />
- Improved resilience of skill event reporting. Failed attempts are stored in browser's local cache and are retried
- Enhanced ``SkillsDisplay`` component to support browser's native back button as well as deep linking; this feature was added in all of the libraries
- Implemented route changed event (``handleRouteChanged``) in the ``SkillsDisplay`` component
- Bug Fixes

## 3.2.0 <release-date date="Apr. 2021" />
## 3.2.0
<release-date date="Apr. 2021" />
- Allow ``SkillsConfiguration.configure`` to be called multiple times
- Disabled automatic OAuth redirection by default
- Improved Cypress.io tests

## 3.1.1 <release-date date="Dec. 2020" />
## 3.1.1
<release-date date="Dec. 2020" />
- Upgraded axios

## 3.1.0 <release-date date="Dec. 2020" />
## 3.1.0
<release-date date="Dec. 2020" />
- Added full OAuth support for the SkillTree platform (dashboard as well as client libraries)
- Upgraded maven and npm dependencies

## 3.0.1 <release-date date="Sep. 2020" />
## 3.0.1
<release-date date="Sep. 2020" />
- Added JS-based logging
- Improved error messages
- Bug fix where Existing Authorization headers can cause client-display rendering to fail

## 3.0.0 <release-date date="Sep. 2020" />
## 3.0.0
<release-date date="Sep. 2020" />
- Implemented Angular SkillTree Integration libraries
- Implemented process to publish releases to Npmjs
- Implemented extensive GitHub Actions Continuous Integration (CI)
Expand Down
Loading