295: documented skills-client:3.6.0

NationalSecurityAgency · Oct 9, 2024 · c7bfc41 · c7bfc41
1 parent dca4a8a
commit c7bfc41
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 6 deletions.
diff --git a/docs/release-notes/skills-client.md b/docs/release-notes/skills-client.md
@@ -8,6 +8,27 @@ To obtain deployable artifacts please visit [Distributions](/dashboard/install-g
 
 </conditional>
 
+::: tip Important Note:
+To enable seamless integration with Skills Display, this library utilizes an iFrame wrapper to retrieve
+the necessary views and data from the skills-service application. This deliberate architectural design choice is a key
+aspect of the SkillTree Platform, as it minimizes the need for frequent upgrades to the skills-client library.
+
+By decoupling the Skills Display functionality from the skills-client library, we've achieved a significant advantage:
+most updates and improvements to Skills Display will be automatically reflected in the skills-client library whenever
+the skills-service application is upgraded. This means that skills-client integrators can enjoy the benefits of new
+features and enhancements without the need for manual library updates.
+
+As a result, **the skills-client libraries are intentionally designed to be relatively static, with infrequent releases**.
+This approach ensures that integrators can rely on a stable and consistent library, while still benefiting from the
+ongoing evolution of the SkillTree Platform.
+:::
+
+## 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" />
 - Ensure that skills-client react libraries work with React 18
 - Removed history package dependency

diff --git a/docs/skills-client/common/skillsConfiguration/skillsConfigurationParameters.md b/docs/skills-client/common/skillsConfiguration/skillsConfigurationParameters.md
@@ -2,11 +2,11 @@ This configuration is used by the Skills Display and Skills Reporting libraries
 
  ```SkillsConfiguration``` ```configure``` parameters:
 
-| Parameter        |Type| Explanation           |
-| ------------- |:-------------- |:-------------|
-| serviceUrl    | String (representing URL) | url to the skills service - this is the same url as the dashboard - the User Interface and service endpoints are co-located | 
-| projectId      | String | the id of the project that was created in the dashboard; visualize and report skills for the project with this id |   
-| authenticator | String | <conditional visibilityFlag="passwordAuthInstall">url to your [Authentication Endpoint](/skills-client/auth.html#authentication)</conditional><conditional visibilityFlag="pkiAuthInstallOnly">always set this value to ``pki`` (the SkillTree platform can be installed in other modes, that is when changing this value would come into play)</conditional> |   
-
+| Parameter     | Type                      | Explanation                                                                                                                                                                                                                                                                                                                                                   |
+|---------------|:--------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| serviceUrl    | String (representing URL) | url to the skills service - this is the same url as the dashboard - the User Interface and service endpoints are co-located                                                                                                                                                                                                                                   | 
+| projectId     | String                    | the id of the project that was created in the dashboard; visualize and report skills for the project with this id                                                                                                                                                                                                                                             |   
+| authenticator | String                    | <conditional visibilityFlag="passwordAuthInstall">url to your [Authentication Endpoint](/skills-client/auth.html#authentication)</conditional><conditional visibilityFlag="pkiAuthInstallOnly">always set this value to ``pki`` (the SkillTree platform can be installed in other modes, that is when changing this value would come into play)</conditional> |   
+| enabled       | Boolean                   | <since project="skills-client" version="3.6.0" :is-block="true"/> (optional, default is `true`) When set to false, when disabled, the skills-client library goes into a dormant state and does not attempt authentication, network communication, skill reporting, or any other activities.                                                                   | 
 SkillsConfiguration supplies the ***afterConfigure()*** method which returns a promise which will be resolved once the **SkillsConfiguration** ***configure*** method
 completes.  This allows support, for example, for configuration options to be supplied by the server asynchronously.