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.

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

docs: delete the architecture folder [skip ci] #996

Merged
merged 1 commit into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 2 additions & 28 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@
# Atala v2 Documentation
# Identus Cloud Agent Documentation

This is the landing page for the Atala v2 technical documentation set.

## Architecture diagrams

The diagrams are based on the [C4 model](https://c4model.com) to describe the architecture at different levels of details:
1. ***Context***: provides a starting point, showing how the software system in scope fits into the world around it.
2. ***Containers***: zooms into the software system in scope, showing the high-level technical building blocks.
3. ***Components***: zooms into an individual container, showing the components inside it.
4. ***Code***: optional, can be used to zoom into an individual component, showing how that component is implemented.

We use the [Diagrams as code](https://diagrams-as-code.com) approach, coding using the [Structurizr DSL](https://structurizr.com).

### Source files

Source code for the different diagrams can be found in the DSL files located [here](./architecture/structurizr).

### Visualisation

A visual and interactive representation of the diagrams can be rendered using [Structurizr Lite](https://structurizr.com/help/lite).

The following [Dockerfile](./architecture/Dockerfile) is provided to create a custom Docker image of Structurizr Lite that embeds the Atala DSL files.
To build the custom image, execute the following command from the repo's root folder:
```bash
docker build -t atala-structurizr-lite docs/architecture
```
This is the landing page for the Cloud Agent technical documentation set.

## OpenAPI Specifications

Expand All @@ -43,11 +19,9 @@ Swagger UI is available as a [Docker image](https://hub.docker.com/r/swaggerapi/

The following [docker-compose.yml](./docker-compose.yml) file can be used to run both services in one shot by executing the following command from the repo's root folder:

***!!! Make sure to build the custom Atala Structurizr Lite Docker image first as described above.***
```bash
docker-compose -f docs/docker-compose.yml up
```
- Architecture diagrams doc is available on *localhost:8080*
- OpenAPI specifications doc is available *localhost:8081*


Expand Down
3 changes: 0 additions & 3 deletions docs/architecture/Dockerfile

This file was deleted.

40 changes: 0 additions & 40 deletions docs/architecture/structurizr/castor_containers.dsl

This file was deleted.

14 changes: 0 additions & 14 deletions docs/architecture/structurizr/iris_containers.dsl

This file was deleted.

82 changes: 0 additions & 82 deletions docs/architecture/structurizr/prism_model.dsl

This file was deleted.

1 change: 0 additions & 1 deletion docs/architecture/structurizr/shared/iris_client.dsl

This file was deleted.

72 changes: 0 additions & 72 deletions docs/architecture/structurizr/workspace.dsl

This file was deleted.

Loading
Loading