Release Month: 📆 {{ date }}
7 |
8 |
9 |
23 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | node_modules
3 | /dist
4 | /docs/.vuepress/dist
5 | *.iml
6 |
7 | # local env files
8 | .env.local
9 | .env.*.local
10 | *.iml
11 |
12 | # Log files
13 | npm-debug.log*
14 | yarn-debug.log*
15 | yarn-error.log*
16 |
17 | # Editor directories and files
18 | .idea
19 | .vscode
20 | *.suo
21 | *.ntvs*
22 | *.njsproj
23 | *.sln
24 | *.sw?
25 |
26 | package-lock.json
27 | /docs/.vuepress/public/img/average_accessibility_score.svg
28 | /docs/.vuepress/.cache
29 | /docs/.vuepress/.temp
30 |
31 | cypress/videos/**
32 | cypress/screenshots/**
33 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/SkillTreeVideos.vue:
--------------------------------------------------------------------------------
1 |
8 |
9 |
10 |
11 |
19 |
20 |
21 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/dashboard/user-guide/common/rte.md:
--------------------------------------------------------------------------------
1 | The editor offers the following features:
2 |
3 |
13 |
17 |
18 | 17 |
7 | 🛡️ Requires {{ role }} Role
8 |
9 |
10 |
11 |
12 |
23 |
--------------------------------------------------------------------------------
/docs/training-participation/common/accessibility-skip-to-content.md:
--------------------------------------------------------------------------------
1 | The "Skip to content" feature helps you quickly access the main content by bypassing repetitive navigation links. This button appears when you first press the `Tab` key on any page.
2 |
3 | To use this feature:
4 | 1. Press `Tab` when the page loads
5 | 2. The "Skip to content" button will appear in the top-left corner and be automatically selected
6 | 3. Press `Enter` to jump directly to the main content area
7 |
8 | ::: tip
9 | You can access this feature at any time by refreshing the page with `F5` and then pressing `Tab`.
10 | :::
--------------------------------------------------------------------------------
/docs/training-participation/common/screen-reader-support.md:
--------------------------------------------------------------------------------
1 | - Decorative images and icons are labeled to be skipped by screen readers
2 | - Many actions are announced to screen readers for better accessibility, this is in addition to the default announcements provided by the browser
3 | - All form fields have associated labels
4 | - Clicking on a form field label will focus the field
5 | - Required fields are clearly indicated
6 | - Error messages are announced by screen readers
7 | - Buttons have descriptive text
8 | - Interactive elements are keyboard accessible
9 | - Focus indicators are visible for keyboard navigation
--------------------------------------------------------------------------------
/docs/dashboard/install-guide/common/two-way-ssl-props.md:
--------------------------------------------------------------------------------
1 | Configure ``https`` and 2-way SSL:
2 | ```properties
3 | server.port=8443
4 | server.ssl.enabled=true
5 | server.ssl.client-auth=want
6 |
7 | # Force TLSv1.2 until https://bugs.openjdk.java.net/browse/JDK-8241248 is fixed
8 | server.ssl.enabled-protocols=TLSv1.2
9 |
10 | # keystore
11 | server.ssl.key-store=/certs/keystore.p12
12 | server.ssl.key-store-password=
13 | server.ssl.keyStoreType=PKCS12
14 |
15 | # truststore
16 | server.ssl.trust-store=/certs/truststore.p12
17 | server.ssl.trust-store-password=
18 | server.ssl.trustStoreType=PKCS12
19 | ```
20 |
--------------------------------------------------------------------------------
/docs/skills-client/common/skillsDisplayArguments.md:
--------------------------------------------------------------------------------
1 | | Prop | Type | Explanation |
2 | | ------------- |:------------ |:-------------|
3 | | version | Number | *(Optional)* version to use in [Skills Versioning](/dashboard/user-guide/skills.html#skills-versioning) paradigm |
4 | | options | Object | *(Optional)* options object to control various behaviors of skills-display. See [Skills Display Options Object](#skills-display-options-object)
5 | | theme | Object | *(Optional)* theme object to customize colors. See [Skills Display Theme Object](#skills-display-theme-object)
6 |
--------------------------------------------------------------------------------
/src/App.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
6 |
7 |
8 |
18 |
19 |
29 |
--------------------------------------------------------------------------------
/docs/dashboard/user-guide/inception.md:
--------------------------------------------------------------------------------
1 | # Inception
2 |
3 | Inception is a special project within the dashboard that gamifies training for the dashboard itself.
4 | All the dashboard users will have a button on the top right of the application which navigates to your skills profile for the Inception project.
5 | This button will also display your current level standing.
6 |
7 | 
8 |
9 | The Inception project by default is owned and managed by any Root Administrator of the dashboard. Root Administrators have the ability to add other users as administrators of the Inception project.
10 |
--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
4 |
12 |
20 |
21 |
22 |
25 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/Since.vue:
--------------------------------------------------------------------------------
1 |
5 |
6 |
7 |
8 | 🕓 Since {{ project }}:{{ version }}
9 |
10 |
11 |
12 |
32 |
--------------------------------------------------------------------------------
/docs/skills-client/common/skillsConfiguration/js/clientConfig.md:
--------------------------------------------------------------------------------
1 | {{ videoMeta.title }}
13 |14 | {{ videoMeta.description }} 15 |
16 |
17 | Watch the Video
18 |
19 |
13 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/skills-client/common/skillsConfiguration/ng/clientConfig.md:
--------------------------------------------------------------------------------
1 |
8 |
20 |
9 | ![Sample Code]()
11 |
12 |
13 |
19 |
14 |
18 | Rapid Integration
15 |Quickly integrate gamified training into your web-application.
16 | Integration Guide 17 |
7 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/docs/.vuepress/components/home/UserDisplaySection.vue:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
8 |
25 |
9 |
13 | User Engagement
10 |Enable users to Quickly learn new skills and effectively master advanced knowledge. 11 | Improve training recall through continued user engagement.
12 |
14 |
18 | Gamification
15 |Consistent and innovative solution takes the guesswork and maintenance out of 16 | implementing gamified training.
17 |
19 |
24 | Reduced Cost
20 |Fewer training sessions - less support costs. Continued user engagement in 21 | application 22 | training promotes local experts.
23 |
8 |
22 |
9 |
14 | User Display
10 |Pluggable user skill and ranking visualization - customize and use the 11 | display component 12 | in your application within minutes.
13 |
15 |
21 |
16 | 
19 |
20 |
19 |
7 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/.github/workflows/verify-build.yml:
--------------------------------------------------------------------------------
1 | # Copyright 2020 SkillTree
2 | #
3 | # Licensed under the Apache License, Version 2.0 (the "License");
4 | # you may not use this file except in compliance with the License.
5 | # You may obtain a copy of the License at
6 | #
7 | # https://www.apache.org/licenses/LICENSE-2.0
8 | #
9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 |
15 | name: Verify Docs Build
16 |
17 | on:
18 | push:
19 | branches:
20 | - '**' # matches every branch
21 | - '!master' # excludes master
22 |
23 | jobs:
24 |
25 | build-and-deploy:
26 | runs-on: ubuntu-latest
27 |
28 | steps:
29 | - uses: actions/checkout@v4
30 |
31 | - uses: actions/setup-node@v4
32 | with:
33 | node-version: '20.17.0'
34 |
35 | - name: npm install
36 | run : npm install
37 |
38 | - name: build docs
39 | run: npm run docs:build
40 |
--------------------------------------------------------------------------------
/docs/skills-client/auth/endpointParamsPKI.md:
--------------------------------------------------------------------------------
1 |
2 | | Parameter | Explanation |
3 | | ------------- |----------------------------------------------------------------------------------------------------------------------------------------------------|
4 | | userId | *(optional)* User certificate's **Distinguished Name (DN)** to report skill event on behalf of another user **(must be an admin of the project)**. |
5 | | timestamp | *(optional)* Report skill event in the past **(must be an admin of the project)**. |
6 | | notifyIfSkillNotApplied | *(optional)* If set to ```true```, notify all client global event handlers even if the reported skill is not applied. Defaults to ```false```. |
7 |
8 | Here is an example JSON payload for reporting a skill event for another user in the past:
9 |
10 | ```json
11 | {
12 | "userId":"cn=aaa@email.foo, ou=integration tests, o=skilltree test, c=us",
13 | "timestamp":1581349194294,
14 | "notifyIfSkillNotApplied": false
15 | }
16 | ```
17 |
--------------------------------------------------------------------------------
/docs/skills-client/auth/endpointsFormPKI.md:
--------------------------------------------------------------------------------
1 | In [Password Auth Installation](/dashboard/install-guide/installModes.html#passwordauth-mode), the OAuth2 protocol is utilized, you will need to:
2 | 1. retrieve user specific temporary client token
3 | - using project's ```Client ID``` and ```Client Secret``` (found in the dashboard under ```Project -> Access -> 'Trusted Client Properties'``` ).
4 | - ``user-to-proxy-for`` is provided in the request (this is the ``user id``).
5 | - result token encapsulates the ``user id`` so the service will know what user to perform this action for
6 | 1. call the endpoint and set the user token on the request.
7 |
8 | Here is a CURL based example: (please substitute your values of ``client-id``, ``client-secret``, ``dashboard-url`` and ``user-to-proxy-for``):
9 |
10 | ```bash
11 | curl client-id:client-secret@dashboard-url/oauth/token -d "grant_type=client_credentials&proxy_user=user-to-proxy-for"
12 | ```
13 |
14 | and then (please substitute your values of ``access_token_from_first_call``, ``dashboard-url``):
15 | ```bash
16 | curl -H "Authorization: Bearer access_token_from_first_call" http://dashboard-url/api/projects/FirstProject/level
17 | ```
18 |
--------------------------------------------------------------------------------
/docs/dashboard/user-guide/contact-project-users.md:
--------------------------------------------------------------------------------
1 | # Contact Users
2 |
3 | A Project's Contact Users page gives Project Administrators the ability to communicate with the users of their project
4 | based off a variety of different filters.
5 |
6 | ::: warning Important
7 | This feature will only be enabled if the necessary [email configuration](/dashboard/user-guide/settings.html#email-notifications) properties have been set for this instance
8 | of SkillTree
9 | :::
10 |
11 | 
12 |
13 | Up to 15 different filters can be combined to target users of your project based on the achievement of levels across the Project/Subjects as well as the achievement specific Badges and Skills or the
14 | lack of achievement of specific Skills.
15 |
16 | Once a Project Administrator has selected the desired filters, they can create an email that can be sent to the selected users. The
17 | specified email can also be previewed using the ```Preview``` button. This will send the specified email to the currently authenticated
18 | user so that formatting, content, and display can be validated.
19 |
20 | ::: tip
21 | The email body supports markdown
22 | :::
23 |
--------------------------------------------------------------------------------
/docs/dashboard/install-guide/common/services-explanations.md:
--------------------------------------------------------------------------------
1 | **1: Clustered deployment of ``skills-service``** for high-availability and higher throughput
2 | - Route requests through a load balancer
3 |
4 | **2: Database** - We currently only support
8 |
34 |
9 | 
13 |
14 |
13 |
15 |
33 | Dashboard
16 |A web-based user interface that enables creation and management of multiple 17 | training profiles and acts as a Learning Management System (LMS).
18 |-
19 |
- Effective and visual creation and management of the 20 | training profiles 21 | 22 |
- Visibility of corporate expertise and knowledge gaps 23 |
- Take training by completing skills, gaining points, 24 | achieving badges, passing quizzes, completing surveys and much, much more... 25 | 26 |
29 | Dashboard 30 | Guide 31 |
32 |
3 |
31 |
32 |
33 |
41 |
42 |
43 |
59 |
--------------------------------------------------------------------------------
/docs/dashboard/user-guide/skills-groups.md:
--------------------------------------------------------------------------------
1 | # Skill Groups
2 |
3 |
4 | Skill Groups is a way to group/organize skills under a subject.
5 | Projects are composed of Subjects which are made of either [Skills](/dashboard/user-guide/skills.html) or Skill Groups.
6 | A group is a collection of 2 or more skills that you want to keep and achieve together.
7 | A group is achieved when all of its skills are fully completed.
8 | Alternatively, a group can be configured to only require ``N`` number of the group's skills.
9 |
10 | ::: tip Partial Requirement Example
11 | If let's say a group has ``5`` skills, you can configure it to only require ``3`` skills.
12 | In this case, when any of the ``3`` skills under that group are completed then the group achievement is awarded!
13 | :::
14 |
15 | 
16 |
17 | To create a group, navigate to ``Project -> Subject`` then click on ``Group +``, the following group properties can be specified:
18 |
19 | 
20 |
21 | | Property | Explanation |
22 | |:------- |:----------- |
23 | | Group Name | Display name of the skill |
24 | | Group ID | Group ID that will be used to identify this group |
25 | | [Description](/dashboard/user-guide/rich-text-editor.html) | *(Optional)* Description of how to perform this skill. |
26 |
27 | After a group is created then skills can be added to the group. To add Skills to the group expand the group and click on the ``Add Skill To Group`` button.
28 | This will bring up a new skill dialog, to learn more about skills and their attributes please visit the [Skills Section](/dashboard/user-guide/skills.html).
29 |
30 | ::: tip
31 | When first created, a Group is not visible on the Skills Display because it has 0 skills.
32 | Once at least 1 skill is added the group will be rendered in the Skills Display.
33 | :::
34 |
35 | ## Partial Skill Requirement
36 |
37 | Groups have an option to only require ``N`` skills out of the total available number of skills added to the group.
38 | For example, if a group has ``5`` skills, you can configure it to only require the completion of ``3`` skills.
39 | In this case, when any ``3`` skills under that group are completed then the group achievement is awarded!
40 |
--------------------------------------------------------------------------------
/docs/dashboard/install-guide/README.md:
--------------------------------------------------------------------------------
1 | # Overview
2 |
3 | This section focuses on installing the SkillTree platform.
4 | Once the service is installed you will have access to the management dashboard and API.
5 |
6 | {{ msg }}
4 |
5 | For a guide and recipes on how to configure / customize this project,
6 | check out the
7 | vue-cli documentation.
8 |
Installed CLI Plugins
10 | 14 |Essential Links
15 |-
16 |
- Core Docs 17 |
- Forum 18 |
- Community Chat 19 |
- News 21 |
Ecosystem
23 |-
24 |
- vue-router 25 |
- vuex 26 |
- vue-devtools 27 |
- vue-loader 28 |
- awesome-vue 29 |
58 |
72 |
77 |
78 |
79 |
122 |
123 |
--------------------------------------------------------------------------------
/docs/training-participation/accessibility.md:
--------------------------------------------------------------------------------
1 | # Accessibility
2 |
3 | SkillTree is committed to providing an accessible learning experience for all users. This guide outlines the accessibility features and best practices to enhance your experience with the platform.
4 |
5 | ::: tip Please Note
6 | If you're interested in creating gamified training experiences rather than earning credits in existing trainings, please check out our [Administrative Accessibility Guide](/dashboard/user-guide/accessibility.html) for more details.
7 | :::
8 |
9 | ## Navigation
10 |
11 | ### Basic Navigation
12 |
73 |
76 |