Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#287: updated contribution guide and develoment guide for skills-serv… #288

Merged
merged 1 commit into from
Aug 14, 2024
Merged

#287: updated contribution guide and develoment guide for skills-serv… #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions docs/contribution/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ SkillTree's skills-service is then configured to use PostgeSQL and Stomp Brokers
![Dashboard with Integrated Application](./diagrams/SkillsServiceArchitecture.jpg)

Integrated clients utilize skills-client libs posted on the public NPM repositories.
These libraries are very thin wrappers around an iFrame tag, they simply retrieve the Skills Display app and its associated data from the skills-service.
What that means is that the Skills Display is served as its own web-based application from the skills-service and then inserted into an iFrame tag on the client's browser.
These libraries are very thin wrappers around an iFrame tag, they simply retrieve the Skills Display views and its associated data from the skills-service application.
What that means is that the Skills Display is served as its own dedicated url from the Dashboard application of the skills-service and then inserted into an iFrame tag on the client's browser.
Of course all of these details are 100% hidden from the skills-client library users.
The skills-service also serves the dashboard as a separate application and that is what is returned by default when users arrive at the "/" url.

The skills-client libraries also enable integrators to report skill events.
Skill reporting utilities will call the [Report Skill Event Endpoint](/skills-client/endpoints.html#report-skill-event-endpoint) which is exposed via the skills-service.
Expand All @@ -32,8 +31,8 @@ External clients may report skill events directly via the [Report Skill Event En

## SkillTree Repositories

1. [skills-service](https://github.com/NationalSecurityAgency/skills-service): has code for the skills service, dashboard and client display. This is where the majority of code changes occur.
1. [skills-client](https://github.com/NationalSecurityAgency/skills-client): client JS libraries that provide skill event reporting utilities and a thin iFrame-based wrapper for the client display.
1. [skills-service](https://github.com/NationalSecurityAgency/skills-service): has code for the skills service and dashboard. This is where the majority of code changes occur.
1. [skills-client](https://github.com/NationalSecurityAgency/skills-client): client JS libraries that provide skill event reporting utilities and a thin iFrame-based wrapper for the Skills Display.
1. [skills-docs](https://github.com/NationalSecurityAgency/skills-docs): Documentation, you are reading this now!
1. [skills-stress-test](https://github.com/NationalSecurityAgency/skills-stress-test): Web-based application that facilitates stress tests against the SkillTree service.
1. [call-stack-profiler](https://github.com/NationalSecurityAgency/call-stack-profiler): Groovy annotation-driven in-code profiling utility used by the services.
Expand Down
Loading
Loading