spell check ARCHITECTURE.md
# Architecture
-This document is a draft of the FASTEN Knowledge base service. The knowledge base comprises of four components:
-`libfasten-core`, `libfasten-analyzer`, `libfasten-pipeliner`, and `libfasten-server`. An overview of each component is
-described below:
+This document is a draft of the FASTEN knowledge base service. The knowledge base comprises four components: `libfasten-core`, `libfasten-analyzer`, `libfasten-pipeliner`, and `libfasten-server`. An overview of each component is described below:
- `libfasten-core`: [webgraph](http://webgraph.di.unimi.it/) already provide functionality to store and
query graph data from billions of nodes and edges. Our goal is to extend [webgraph](http://webgraph.di.unimi.it/)
@@ -17,12 +15,10 @@ described below:
- __security:__ calculating the transitive closure of affected dependent packages
- __API analytics:__ following trends on deprecation/removal/adaption of package APIs.
- __change impact/semantic changes:__ quantifies the impact of new releases or releases made.
-- `libfasten-pipeliner`: Orchestration component for creating workflow pipelines using `libfasten-core` and
- `libfasten-analyzer`. Event feed data will come from [Codefeedr](https://github.com/codefeedr/codefeedr) such as
- CVE or licence data. The component will also create new queryable and push-based event streams such as
- a "the daily top-10 most imported library function". Package manager plugins will interface this component for
- push-based notifications.
-- `libfasten-server:` REST API to interface the knowledge and its various components.
+- `libfasten-pipeliner`:
+ - Orchestration component for creating workflow pipelines using `libfasten-core` and `libfasten-analyzer`. Event feed data will come from [Codefeedr](https://github.com/codefeedr/codefeedr) such as CVE or licence data. The component will also create new queryable and push-based event streams such as a "the daily top-10 most imported library function". Package manager plugins will interface this component for push-based notifications.
+- `libfasten-server:`
+ - REST API to interface the knowledge and its various components.
### Data specifications
@@ -34,4 +30,4 @@ Here we enlist data sources that the knowledge base will interact with:
- Call graphs
- API requests from users
- Metadata related to nodes and edges in the graph
-- Security advisories, licencing, function body information (e.g., LOC, complexity)
+- Security advisories, licensing, function body information (e.g., LOC, complexity)
