Update docs (#79)

Author: MaartendeKruijf

README.md

@@ -2,8 +2,8 @@
 <a href="https://cossas-project.org/cossas-software/soarca"><img src="img/soarca-logo.svg"/>
 
 
-![https://cossas-project.org/portfolio/SOARCA/](https://img.shields.io/badge/website-cossas--project.org-orange)
-![Pipeline status](https://github.com/cossas/soarca/actions/workflows/ci.yml/badge.svg?development)
+[![https://cossas-project.org/portfolio/SOARCA/](https://img.shields.io/badge/website-cossas--project.org-orange)](https://cossas-project.org/portfolio/SOARCA/)
+[![Pipeline status](https://github.com/cossas/soarca/actions/workflows/ci.yml/badge.svg?development)](https://github.com/COSSAS/SOARCA/actions)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 </div></a>
 

doc/fin.md

@@ -0,0 +1,8 @@
+---
+title: SOARCA V1.0
+date: 2024-03-19
+description: >
+    SOARCA release 1.0
+---
+
+The first release of SOARCA.

doc/soarca.md

@@ -7,7 +7,7 @@ weight: 20
 
 
 {{% alert title="Warning" color="warning" %}}
-SOARCA is currently in its **alpha release**, with ongoing development aimed at expanding its capabilities, improving integration, and enhancing its functionalities. You can track our progress and upcoming milestones at [LINK TO ROADMAP].
+SOARCA is currently in its **first release**, with ongoing development aimed at expanding its capabilities, improving integration, and enhancing its functionalities. You can track our progress and upcoming milestones on [GitHub](https://github.com/COSSAS/SOARCA/milestones).
 
 We warmly welcome contributions to our repository. You can find the guidelines for contributing [here](/docs/contribution-guidelines).
 {{% /alert %}}

docs/content/en/blog/releases/in-depth-monoliths-detailed-spec.md

@@ -28,10 +28,11 @@ SOARCA is a project initiated and supported by [TNO](https://tno.nl), the Nether
 A special thanks to:
 
 - Sebastiaan Huskins for laying the initial and technical foundation for SOARCA. 
-- Myla Fransen for the logo designs. 
+- Myla Fransen for the logo designs.
+- David Roefs as part of the AInception team
 
 ## About SOARCA 
 
-This work has received funding from the European Union’s Horizon Europe Energy Research and Innovation programme under Grant Agreement No. 101075665 ([eFORT](https://efort-project.eu/) project) and the European Defence Fund (EDF) under Grant Agreement No. 101103385 ([AInception](https://www.ainception.eu/) project). Views and opinions expressed in this documentation are those of the authors only and do not necessarily reflect those of the European Union. Neither the European Union nor the granting authority can be held responsible for them.
+This work has received funding from the European Union’s Horizon Europe Energy Research and Innovation programme under Grant Agreement No. 101075665 ([eFORT](https://efort-project.eu/) project) and the European Defence Fund (EDF) under Grant Agreement No. 101103385 ([AInception](https://www.ainception.eu/) project). Views and opinions expressed are those of the authors only and do not necessarily reflect those of the European Union or European Climate, Infrastructure and Environment Executive Agency (CINEA). Neither the European Union nor the granting authority can be held responsible for them.
 
 ![eu-funded](/SOARCA/images/eu-funded-logo.png)

docs/content/en/blog/releases/release1-0.md

@@ -44,7 +44,7 @@ The CI is configured to only allow for certain branch naming namely:
 - development
 - feature/<your feature name here>
 - feature/docs/<your feature to update docs>
-- bugfix/<your bugfix here> #it should be small!
+- bugfix/<your bugfix here>
 - release/x.x
 - hotfix/<your hotfix on a release branch>
 
@@ -83,4 +83,4 @@ If you've just spotted something you'd like to change while using the docs, Docs
 
 ## License 
 
-The project is licensed under the Apache License 2.0. See full license [here](https://github.com).
+The project is licensed under the Apache License 2.0. See full license [here](https://github.com/COSSAS/SOARCA/blob/development/LICENSE).

docs/content/en/docs/_index.md

@@ -14,3 +14,9 @@ SOARCA consists of several key components:
 
 
 ![core](/SOARCA/images/core_color.png)
+
+## Core component overview
+
+SOARCA has interaction with may components the following diagram shows the intended setup for SOARCA and its components. Currently not all parts are fully implemented. Keep track of the release notes to see what's implemented and what needs some work.
+
+![core detailed](/SOARCA/images/soarca-functional-design.jpg)

docs/content/en/docs/about/_index.md

@@ -4,33 +4,33 @@ description: Getting SOARCA quickly setup
 categories: [documentation, getting-started]
 tags: [docker, bash]
 weight: 2
-date: 2023-01-05
+date: 2024-03-18
 ---
 
 ## Prerequisites
 
-Before you begin, you might need to install the following tools:
-
+Before you begin, you might need to install the following tools (Linux Ubuntu 22.04 adapt for your needs): 
 
 - [golang](https://go.dev/doc/install)
+- go gin `go get -u github.com/gin-gonic/gin`
+- swaggo `go install github.com/swaggo/swag/cmd/swag@latest`
+- cyclonedx-gomod `go install github.com/CycloneDX/cyclonedx-gomod/cmd/cyclonedx-gomod@latest`
+- make `sudo apt install build-essential`
 - [docker & docker compose](https://docs.docker.com/engine/install/)
 
 ## Quick Run
 
-Below, we outline various options to kickstart SOARCA. The latest pre-compiled releases can be found [here]().
+Below, we outline various options to kickstart SOARCA. The latest pre-compiled releases can be found [here](https://github.com/COSSAS/SOARCA/releases).
 
 {{< tabpane langEqualsHeader=false  >}}
 {{< tab header="make" lang="sh" >}}
-make run
+make build && ./build/soarca
 {{< /tab >}}
 {{< tab header="Linux" lang="sh" >}}
-wget .... && chmod +x {}
-{{< /tab >}}
-{{< tab header="Docker" lang="sh" >}}
-sudo docker compose up -d
+wget https://github.com/COSSAS/SOARCA/releases/download/SOARCA_1.0.0/SOARCA_1.0.0_linux_amd64.tar.gz  && tar -xvf SOARCA* && ./SOARCA
 {{< /tab >}}
 {{< tab header="Docker Compose" lang="sh" >}}
-make run
+cd docker/soarca && sudo docker compose up -d
 {{< /tab >}}
 {{< /tabpane >}}
 
@@ -79,8 +79,13 @@ LOG_FORMAT: "json"
 
 ### Docker hub 
 
-`<to be added soon>`
+`docker pull cossas/soarca`
 
 ### Building from Source
 
-`<to be added soon>`
+```bash
+git clone https://github.com/COSSAS/SOARCA.git
+make build
+cp .env.example .env
+./build/soarca
+```