From e9a11fbbca9fde198bd14d1ce0a106c11c25143a Mon Sep 17 00:00:00 2001 From: Dima May Date: Wed, 20 Nov 2024 16:36:28 +0000 Subject: [PATCH 1/2] updated README and project home page link --- README.md | 2 +- .../main/groovy/skills/ReleaseClientLibs.groovy | 7 ------- skills-client-js/README.md | 17 +++++++++-------- skills-client-js/package.json | 2 +- 4 files changed, 11 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e9b1b048..c08422e9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ SkillTree is an innovative approach to implementing application training. SkillTree skills-client project is an assembly of client libraries that facilitate rapid integration with the SkillTree service. -To learn about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/). +To learn about the SkillTree platform please visit our [Official Documentation](https://skilltreeplatform.dev/). These pages provide in-depth guidance on the installation, usage and contribution. ## Workflow Status diff --git a/skills-client-integration/skills-int-e2e-test/src/main/groovy/skills/ReleaseClientLibs.groovy b/skills-client-integration/skills-int-e2e-test/src/main/groovy/skills/ReleaseClientLibs.groovy index af24900a..58009cd1 100644 --- a/skills-client-integration/skills-int-e2e-test/src/main/groovy/skills/ReleaseClientLibs.groovy +++ b/skills-client-integration/skills-int-e2e-test/src/main/groovy/skills/ReleaseClientLibs.groovy @@ -103,12 +103,5 @@ class ReleaseClientLibs { json.dependencies.findAll { it.key.startsWith(Vars.NpmNamespace) }.each { assert json.dependencies."${it.key}" == newVersion } - - if (npmProj.angularModule) { - File loc = new File(npmProj.loc, "projects/skilltree/skills-client-ng/") - assert loc.exists() - NpmProj angularProj = new NpmProj(loc: loc, name: loc.name, doOthersLinkToMe: true) - updateVersion(angularProj, newVersion) - } } } diff --git a/skills-client-js/README.md b/skills-client-js/README.md index f3dfc6cd..45ffe0fb 100644 --- a/skills-client-js/README.md +++ b/skills-client-js/README.md @@ -17,9 +17,6 @@ limitations under the License. # SkillTree Client Lib - Native JS Lib

- - Current version - npm downloads @@ -33,17 +30,21 @@ limitations under the License. SkillTree is an innovative approach to implementing application training. SkillTree's ``skills-client-js`` project facilitates rapid integration with the SkillTree service. -To learn about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/). +To learn about the SkillTree platform please visit our [Official Documentation](https://skilltreeplatform.dev/). These pages provide in-depth guidance on the installation, usage and contribution. -SkillTree client libraries offer a comprehensive set of features: +## Library Features + +SkillTree client library offer a comprehensive set of features: - **Seamless navigation and visualization:** Our Skill Display component provides a fully navigable Ranking and Visualization view, making it easy for users to explore and understand their skills. - **Effortless skill event reporting:** The SkillsReporter JS utility simplifies the process of reporting skill events, ensuring accurate and timely tracking of user progress. - **Convenient level display:** Our level display component provides a straightforward way to showcase a user's current overall level within the application. -- **Global event handling:** Our JS functions enable applications to register for all skill events, allowing for real-time notifications and updates. For example, you can use this feature to display encouraging messages when users earn points or complete levels, further enhancing their engagement and motivation." +- **Global event handling:** Our JS functions enable applications to register to receive skill events, allowing for real-time notifications and updates. For example, you can use this feature to display encouraging messages when users earn points or complete levels, further enhancing their engagement and motivation. + +## Important Note -**Important Note:** To enable seamless integration with Skills Display, this library utilizes an iFrame wrapper to retrieve +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. @@ -58,4 +59,4 @@ ongoing evolution of the SkillTree Platform. ## Installation and Usage -To learn how to install and use this library please visit [SkillTree's Native JS Integration Guide](https://code.nsa.gov/skills-docs/skills-client/js.html). +To learn how to install and use this library please visit [SkillTree's Native JS Integration Guide](https://skilltreeplatform.dev/skills-client/js.html). diff --git a/skills-client-js/package.json b/skills-client-js/package.json index 5b3f86bb..eb6df4f2 100644 --- a/skills-client-js/package.json +++ b/skills-client-js/package.json @@ -67,7 +67,7 @@ "User Engagement", "Rapid Integration" ], - "homepage": "https://code.nsa.gov/skills-docs/", + "homepage": "https://skilltreeplatform.dev/", "repository": { "type": "git", "url": "git+https://github.com/NationalSecurityAgency/skills-client.git" From 8da314393b8e419c5eaae71630d2e371099ddc8b Mon Sep 17 00:00:00 2001 From: Dima May Date: Wed, 20 Nov 2024 16:49:05 +0000 Subject: [PATCH 2/2] updated README and project home page link --- skills-client-js/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/skills-client-js/README.md b/skills-client-js/README.md index 45ffe0fb..b38a03e7 100644 --- a/skills-client-js/README.md +++ b/skills-client-js/README.md @@ -35,7 +35,7 @@ These pages provide in-depth guidance on the installation, usage and contributio ## Library Features -SkillTree client library offer a comprehensive set of features: +SkillTree client library offers a comprehensive set of features: - **Seamless navigation and visualization:** Our Skill Display component provides a fully navigable Ranking and Visualization view, making it easy for users to explore and understand their skills. - **Effortless skill event reporting:** The SkillsReporter JS utility simplifies the process of reporting skill events, ensuring accurate and timely tracking of user progress.