Skip to content

Commit b3e3bc9

Browse files
committed
bumped docusaurus; added 5 minute tutorial
1 parent 25906b3 commit b3e3bc9

217 files changed

Lines changed: 7842 additions & 3374 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

lasso/docs/intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_position: 1
44

55
# Documentation
66

7-
Discover the **LASSO Platform**.
7+
## 5 Minute Tutorial
8+
9+
Start with our [5 minute tutorial to start the **LASSO Platform** and to submit your first LSL script](./quickstart/scenario.md).
810

911
## Data Structures and Languages
1012

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Quickstart",
3-
"position": 2,
2+
"label": "5 Minute Tutorial",
3+
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important LASSO concepts"
6+
"description": "5 minutes to start LASSO and submit your first LSL script"
77
}
88
}

lasso/docs/quickstart/scenario.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ sidebar_position: 2
44

55
# Quickstart: Submit Your First LSL Script
66

7+
## Start the LASSO Platform and its Executable Corpus
8+
9+
To get started, run the following two commands in a local directory on your machine (requires [docker compose](https://docs.docker.com/compose/)):
10+
11+
```bash
12+
curl https://raw.githubusercontent.com/SoftwareObservatorium/lasso/refs/heads/develop/docker/compose/docker-compose-embedded.yml -o docker-compose.yml
13+
docker compose up
14+
```
15+
16+
Wait until all services started (LASSO platform, Code Search Index and Artifact Repository) and then open LASSO's dashboard at http://localhost:10222/webui/ (login: admin / admin123).
17+
18+
Note that the corresponding Docker Dockerfiles and compose files can be found in [GitHub](https://github.com/SoftwareObservatorium/lasso/tree/develop/docker). Brief instructions of how the images were built are available [here](https://github.com/SoftwareObservatorium/lasso/blob/develop/DEPLOY_GITLAB_DOCKER.md).
19+
20+
### Infrastructure and Services
21+
22+
Besides the LASSO Platform, the executable corpus services required by the platform are started as well:
23+
24+
* a code search index based on `Apache Solr`, preconfigured for LASSO's code search and analysis services, is started: [Solr Dashboard](http://localhost:8983) (no credentials!)
25+
* an artifact repository based on `Sonatype's Nexus` (Community edition), preconfigured for LASSO's artifact storage, is started: [Nexus Dashboard](http://localhost:8081/) (login: admin / admin)
26+
727
## Submitting a Pipeline using LASSO's Dashboard (Angular Web Application)
828

929
The LASSO platform provides a comprehensive dashboard to manage, monitor, and view results of pipeline scripts and their execution. Additionally, it provides additional services such as code search.
@@ -12,7 +32,7 @@ LASSO' dashboard is accessible at (http://localhost:10222/webui/).
1232

1333
### Step-by-Step Guide to Submit a New Script
1434

15-
1. **Login**: Select the desired user(s) from the [users.json](https://github.com/SoftwareObservatorium/lasso/tree/develop/doc/lasso_config) file.
35+
1. **Login**: Select the desired user(s) from the [users.json](https://github.com/SoftwareObservatorium/lasso/tree/develop/doc/lasso_config) file (default: admin / admin123).
1636
2. **Submit a New LSL Script Pipeline**: see the famous `Hello World` LSL pipeline next.
1737

1838
### Hello World LSL Pipeline Script
@@ -82,6 +102,10 @@ After execution, the dashboard offers various ways to obtain results:
82102
* **Results**: View the results in a classic search results view.
83103
* **Data Analysis**: Analyze data stored in LASSO's database in various ways.
84104

105+
## Software Analytics (SRM/SRH Analysis)
106+
107+
The LSL pipeline script executions result in one or more SRMs that are stored in LASSO's distributed database (based on Apache Ignite). The collection of SRMs effectively results in an SRM data warehouse, which we refer to as stimulus response hypercube (SRH). The data can be export to external analytics tools. You can find more information in [Analysis](../analytics/data.md).
108+
85109
## Next
86110

87111
You can explore more LSL pipelines and their results in [TDSEHub](../../hub)

lasso/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ const config: Config = {
149149
prism: {
150150
theme: prismThemes.github,
151151
darkTheme: prismThemes.dracula,
152-
additionalLanguages: ['java', 'groovy'],
152+
additionalLanguages: ['java', 'groovy', 'bash'],
153153
},
154154
} satisfies Preset.ThemeConfig,
155155
};

0 commit comments

Comments
 (0)