Skip to content

Commit 99d33f3

Browse files
m-kesselm-kessel
committed
updated documentation
1 parent 618a6da commit 99d33f3

60 files changed

Lines changed: 101 additions & 68 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/infrastructure/nexus.md‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,36 @@ You need to update LASSO's configuration file [corpus.json](https://github.com/S
6767

6868
You need to restart LASSO with the updated `corpus.json` configuration file. It might be necessary to update LASSO's Maven configuration in `lasso-work/repository/settings.xml` as well (alternatively, change or removing LASSO's existing work directory).
6969

70-
Note: For advanced use cases with LASSO, setting up a deployment _user_ is a better choice instead of using the admin user.
70+
Note: For advanced use cases with LASSO, setting up a deployment _user_ is a better choice instead of using the admin user. Refer to Sonatype's official documentation to learn more.
7171

72-
## Deployment of LASSO's Support Libraries
72+
## Deployment of LASSO's Support Libraries (Required)
7373

74-
Certain features of LASSO rely on deployed support libraries. To deploy them (see configuration above), run the following command to deploy all LASSO related artifacts to your local Nexus repository
74+
Certain features of LASSO rely on LASSO-related support libraries that need to be deployed in your Nexus instance. This allows LASSO's facilities to access the required libraries.
75+
76+
### Global Maven Deployment Settings
77+
78+
Before proceeding, modify the password in `doc/nexus_config/settings_plugin_deploy.xml` (i.e., local LASSO repository) to match your custom Nexus password. An example of the modified file is shown below -
79+
80+
```xml
81+
...
82+
83+
<servers>
84+
<server>
85+
<id>lasso_quickstart_nexus</id>
86+
<username>admin</username>
87+
<password>YOUR_NEXUS_PASSWORD</password>
88+
</server>
89+
</servers>
90+
91+
...
92+
```
93+
94+
95+
### Deploy LASSO Artifacts
96+
97+
To deploy all LASSO-related artifacts to your local Nexus repository, run the following command in your local LASSO repository -
7598

7699
```bash
77100
# set your path to LASSO's repository
78101
./mvnw -s doc/nexus_config/settings_plugin_deploy.xml -gs doc/nexus_config/settings_plugin_deploy.xml -DskipTests -Dfrontend.build=embedded -DaltDeploymentRepository=lasso_quickstart_nexus::default::http://localhost:8081/repository/lasso-deploy/ -DaltReleaseDeploymentRepository=lasso_quickstart_nexus::default::http://localhost:8081/repository/lasso-deploy/ -DaltSnapshotDeploymentRepository=lasso_quickstart_nexus::default::http://localhost:8081/repository/lasso-deploy/ deploy
79-
```
80-
81-
Note: You need to change the password in `doc/nexus_config/settings_plugin_deploy.xml` to your custom Nexus password (see example).
102+
```

‎lasso/docs/installation/build.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ The project is managed using Maven by relying on _Maven Wrapper_ (https://maven.
99
The following command needs to be executed in the root directory of the repository:
1010

1111
```bash
12+
git clone https://github.com/SoftwareObservatorium/lasso.git
13+
```
14+
15+
```bash
16+
# your local LASSO directory
17+
cd lasso/
18+
1219
./mvnw -DskipTests \
1320
-Dfrontend.build=embedded \
1421
clean install

‎web/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="generator" content="Docusaurus v3.4.0">
66
<title data-rh="true">Page Not Found | LASSO</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://softwareobservatorium.github.io/web/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://softwareobservatorium.github.io/web/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://softwareobservatorium.github.io/web/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | LASSO"><link data-rh="true" rel="icon" href="/web/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://softwareobservatorium.github.io/web/404.html"><link data-rh="true" rel="alternate" href="https://softwareobservatorium.github.io/web/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://softwareobservatorium.github.io/web/404.html" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/web/blog/rss.xml" title="LASSO RSS Feed">
77
<link rel="alternate" type="application/atom+xml" href="/web/blog/atom.xml" title="LASSO Atom Feed"><link rel="stylesheet" href="/web/assets/css/styles.0cf5414e.css">
8-
<script src="/web/assets/js/runtime~main.77894b5e.js" defer="defer"></script>
8+
<script src="/web/assets/js/runtime~main.ce2adb38.js" defer="defer"></script>
99
<script src="/web/assets/js/main.ee948891.js" defer="defer"></script>
1010
</head>
1111
<body class="navigation-with-keyboard">

‎web/about/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="generator" content="Docusaurus v3.4.0">
66
<title data-rh="true">About LASSO | LASSO</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://softwareobservatorium.github.io/web/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://softwareobservatorium.github.io/web/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://softwareobservatorium.github.io/web/about"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="About LASSO | LASSO"><meta data-rh="true" name="description" content="Team / Authors"><meta data-rh="true" property="og:description" content="Team / Authors"><link data-rh="true" rel="icon" href="/web/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://softwareobservatorium.github.io/web/about"><link data-rh="true" rel="alternate" href="https://softwareobservatorium.github.io/web/about" hreflang="en"><link data-rh="true" rel="alternate" href="https://softwareobservatorium.github.io/web/about" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/web/blog/rss.xml" title="LASSO RSS Feed">
77
<link rel="alternate" type="application/atom+xml" href="/web/blog/atom.xml" title="LASSO Atom Feed"><link rel="stylesheet" href="/web/assets/css/styles.0cf5414e.css">
8-
<script src="/web/assets/js/runtime~main.77894b5e.js" defer="defer"></script>
8+
<script src="/web/assets/js/runtime~main.ce2adb38.js" defer="defer"></script>
99
<script src="/web/assets/js/main.ee948891.js" defer="defer"></script>
1010
</head>
1111
<body class="navigation-with-keyboard">

‎web/assets/js/21e7b789.4e210c91.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)