#298: document 3.2 release

cypress/e2e/admin-quiz_and_surveys.cy.js

@@ -94,6 +94,17 @@ context('Admin: Generate Quiz and Surveys Screenshots', () => {
         cy.snap('page-quiz-settings');
     })
 
+    it('quiz grading page', () => {
+        // going to expect email server is already configured
+        cy.viewport(1100, 500);
+        cy.visit('/administrator/quizzes/ChessInsight/grading')
+        cy.get('[data-cy="[email protected]"]').click()
+        cy.get('[data-cy="question_1"] [data-cy="questionDisplayText"]')
+        cy.snap('page-quiz-grading');
+        cy.snap('component-quiz-grading-email-subscriptions', '[data-cy="quizRunsToGradeTable"] [data-pc-section="header"]');
+    })
+
+
     it('quiz survey page', () => {
         // cy.viewport(1100, 500);
         cy.visit('/administrator/quizzes/CodingLanguageandFrameworksPreferences/')

cypress/e2e/admin.cy.js

@@ -624,4 +624,19 @@ context('Admin: Generate Screenshots', () => {
 
     })
 
+    it('page - admin groups', () => {
+        cy.visit('/administrator/adminGroups/FancyGroup')
+        cy.get('[data-cy="roleManagerTable"] [data-cy="skillsBTableTotalRows"]').should('have.text', '3')
+        cy.snap('page-admin-groups')
+
+        cy.visit('/administrator/adminGroups/FancyGroup/group-projects')
+        cy.get('[data-cy="adminGroupProjectsTable"] [data-cy="skillsBTableTotalRows"]').should('have.text', '3')
+        cy.snap('page-admin-groups-projects')
+
+        cy.visit('/administrator/adminGroups/FancyGroup/group-quizzes')
+        cy.get('[data-cy="adminGroupQuizzesTable"] [data-cy="skillsBTableTotalRows"]').should('have.text', '2')
+        cy.snap('page-admin-groups-quizzes')
+
+    })
+
 })

cypress/e2e/progress-and-ranking.cy.js

@@ -119,5 +119,16 @@ context('Progress and Ranking: Generate Screenshots', () => {
     cy.snap('client-display-quiz-run', '[data-cy="skillsDisplayHome"]');
   })
 
+  it('quiz grading attempts page', () => {
+    cy.request('POST', '/logout');
+    cy.login('[email protected]');
+    cy.visit('/progress-and-rankings/my-quiz-attempts')
+    cy.get('[data-cy="myQuizAttemptsTable"] [data-cy="skillsBTableTotalRows"]').should('have.text', '9')
+    cy.snap('page-my-quiz-attempts');
+
+    cy.get('[data-cy="myQuizAttemptsTable"] [data-p-index="0"] a').click()
+    cy.snap('page-my-quiz-single-attempt');
+  })
+
 
 })

cypress/support/commands.js

@@ -45,15 +45,29 @@ Cypress.Commands.add('snap', (name, selector = null, options = {}) => {
     }
 });
 
-Cypress.Commands.add('login', () => {
+Cypress.Commands.add('login', (username = '[email protected]') => {
     cy.visit('/')
-    cy.get('[id="username"]').type('[email protected]');
+    cy.get('[id="username"]').type(username);
     cy.get('[id="inputPassword"]').type('password');
     cy.get('[data-cy="login"]').should('be.enabled')
     cy.get('[data-cy="login"]').click({force: true});
     cy.contains('Progress And Rankings');
 });
 
+Cypress.Commands.add('saveEmailServer', () => {
+    cy.log('configuring email');
+    cy.request({
+        method: 'POST',
+        url: '/root/saveEmailSettings',
+        body: {
+            publicUrl: 'http://localhost:8082/',
+            fromEmail: '[email protected]',
+            host: 'localhost',
+            port: 1025,
+            'protocol': 'smtp'
+        },
+    });
+})
 Cypress.Commands.add('clickNav', (navName) => {
     cy.get(`[data-cy="nav-${navName}"]`).click();
 });

docs/.vuepress/config.js

@@ -110,6 +110,7 @@ sidebar = sidebar.concat([{
             '/dashboard/user-guide/skills-groups',
             '/dashboard/user-guide/rich-text-editor',
             '/dashboard/user-guide/quizzes-and-surveys',
+            '/dashboard/user-guide/admin-groups',
             '/dashboard/user-guide/badges',
             '/dashboard/user-guide/learning-path',
             '/dashboard/user-guide/progress-and-ranking',

docs/dashboard/user-guide/admin-groups.md

@@ -0,0 +1,17 @@
+# Admin Groups
+
+Admin Groups streamline the ability to manage a list of administrators for one or more projects and/or quizzes.
+Once an Admin Group is created you can easily add/remove members to/from it. A group can then be assigned to one or more projects and/or quizzes 
+which then allows the members of the group to have administrative privileges to the assigned projects and/or quizzes. 
+
+To create an admin group please navigate to ``Admin Groups`` page and click ``Admin Group +`` button.
+
+![page-admin-groups.png](../../screenshots/admin/page-admin-groups.png)
+
+To assign a group to a project please navigate to ``Adming Groups -> Projects`` then select one of the existing projects from the dropdown. 
+
+![page-admin-groups-projects.png](../../screenshots/admin/page-admin-groups-projects.png)
+
+To assign a group to a quiz please navigate to ``Adming Groups -> Quizzes`` then select one of the existing quizzes from the dropdown.
+
+![page-admin-groups-quizzes.png](../../screenshots/admin/page-admin-groups-quizzes.png)

docs/dashboard/user-guide/progress-and-ranking.md

@@ -66,6 +66,24 @@ You can customize the landing page by visiting ``Settings -> Preferences``:
 
 ![Preferences Page](../../screenshots/admin/page-settings-preference.png)
 
+## Quizzes and Surveys
+
+You can view your completed quizzes and surveys by visiting the ``My Quizzes and Surveys`` page from the ``My Projects`` page by clicking the ``History`` button on the Quizzes and Surveys card.
+
+![page-my-quiz-attempts.png](../..//screenshots/progress-and-ranking/page-my-quiz-attempts.png)
+
+``My Quizzes and Surveys`` page features a searchable and sortable history table of all the passed and failed quizzes as well as completed surveys. 
+You can drill down into a quiz or survey attempt by clicking on its name. 
+
+![page-my-quiz-single-attempt.png](../../screenshots/progress-and-ranking/page-my-quiz-single-attempt.png)
+
+A single quiz or survey attempt will display the results of that attempt. In case of the survey all the questions and associated selections will be shown. 
+
+In case of a quiz they are number of possible conditions based on the status of the attempt:
+- `Passed` Quiz: all the questions and answer 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 all the answers are displayed
+- `Needs Grading` Quiz: answers are now displayed
+
 ## Badges Page
 
 You can view your earned and available badges by visiting the ``My Badges`` page from the ``My Projects`` page.

docs/dashboard/user-guide/quizzes-and-surveys.md

@@ -47,6 +47,7 @@ in order to earn the skill and its points. In the case of a quiz, then the quiz
 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
+- ``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. 
 
@@ -69,13 +70,37 @@ order to receive the credit for the question
 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 Grading <since project="skills-service" version="3.2" />
+
+
+If a quiz has at least 1 ``Input Text`` question then after a quiz taker submits an attempt quiz administrator will be able to grade the answers for the ``Input Text`` questions.
+
+To do so please navigate to ``Quizzes and Surveys -> Quiz -> Grading`` page.
+
+
+![page-quiz-grading.png](../../screenshots/admin/page-quiz-grading.png)
+
+A table of quiz attempts that contain ``Input Text`` questions will be displayed. Click on the ``Grade`` button to the right of the user to open the grading request. 
+Once expanded answers can be marked as either "Correct" or "Wrong", in addition a justification can be provided. 
+Once all the answer are marked as either correct or wrong, SkillTree system will grade the quiz attempt in its entirety considering all the question in this quiz.
+
+#### Grading Notifications
+SkillTree will send email notifications to quiz administrators when grading is requested and send email notifications to quiz takes when answers are graded.
+
+Quiz administrators can unsubscribe from notifications by navigating to ``Quizzes and Surveys -> Quiz -> Grading`` page.
+
+![component-quiz-grading-email-subscriptions.png](../../screenshots/admin/component-quiz-grading-email-subscriptions.png)
+
+The Grading section contains a Subscribed/Unsubscribed toggle on the top-right of the component.
+
+
 ### Quiz Settings
 
 A Quiz has a number of customization parameters, to customize a quiz please navigate to ``Quizzes and Surveys -> Quiz -> Settings`` page.
 
-![Quiz Single Result Page Screenshot](../../screenshots/admin/page-quiz-settings.png)
+![Quiz Screenshot](../../screenshots/admin/page-quiz-settings.png)
 
-#### Setting: # of Questions per Quiz Attempt <since project="skills-service" version="2.9" />
+#### Setting: # of Questions per Quiz Attempt
 
 When enabled, a sub-set of random questions will be presented to the user taking this quiz. 
 For example, if there are 10 questions and this setting is set to 5, then each time a user takes this quiz
@@ -99,7 +124,7 @@ If enabled, questions are presented in a random order each time the quiz is take
 
 If enabled, each question's answers are presented in a random order each time the quiz is taken.
 
-#### Setting: Quiz Time Limit <since project="skills-service" version="2.10" />
+#### Setting: Quiz Time Limit
 
 If a time limit is set, users will have a specific duration to complete the quiz. 
 If they exceed the time limit, their attempt will be marked as 'Failed'.
@@ -153,6 +178,16 @@ A Survey has customization parameters, to customize a survey please navigate to
 With this feature enabled, users can retake surveys unlimited number of times. The system
 accurately tracks each completion, providing a comprehensive view of user progress and performance.
 
+## Copy
+
+Quizzes, surveys and questions can easily be copied. 
+
+To use an existing Quiz/Survey as a template you can easily copy its declarations (questions, settings, etc..) into a brand-new Quiz/Survey.  
+To copy a Quiz/Survey please use the ![copy button](./screenshots/copy_btn.png) button available on a quizzes/surveys administration page.
+The system will prompt you to enter a new Quiz/Survey name and optionally modify the Quiz/Survey id.
+
+Similarly, to copy a question please use the ![copy button](./screenshots/copy_btn.png) button available on a questions page within a single Quiz/Survey administration.
+
 
 ## Results
 Summarized quiz/survey results can be located on the Results page (``Quizzes and Surveys -> Quiz/Survey -> Results ``). 

docs/release-notes/skills-service.md

@@ -8,6 +8,26 @@ To obtain deployable artifacts please visit [Distributions](/dashboard/install-g
 
 </conditional>
 
+
+## 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.
+  - 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.
+  - Quiz administrators can now add `Input Text` type of questions that require test-takers to compose text answers.
+  - `Input Text` questions are then graded by quiz administrators to either make the answer correct or wrong.
+  - SkillTree emails grading requests and grading results; administrators have an option to unsubscribe.
+- Added visualization of completed surveys and passed/failed quizzes.
+  - Displayed the history of current users' taken quizzes and completed surveys on the Progress and Ranking pages with the ability to drill down into a specific attempt.
+  - Implemented a new card providing a simple quizzes and surveys count on the home page.
+  - When a quiz or a survey is associated with a skill, added the display of the answer for passed quizzes and completed surveys directly on the skill page.
+- Added the ability to copy a quiz or a survey.
+- Added the ability to copy quiz or survey questions.
+- Further enhanced the User Transcript export to show when a skill was achieved and, in the case of approval-based skills, who the approver was.
+- Bug Fixes
+- Upgraded libraries
+
+
 ## 3.1.0 <release-date date="September 2024" />
 - Introducing Data Export Capability for Project Admins: Easily export key data into Excel format, including:
   - [Users' Progress Table](/dashboard/user-guide/users.html): Track current progress in a tabular format