From c47550cadfe676a10757d1b411b964ab5ceddde6 Mon Sep 17 00:00:00 2001 From: Olivier von Dach Date: Thu, 11 May 2023 14:59:12 +0200 Subject: [PATCH] refined tech documentation --- src/doc/mkdocs.yml | 1 + src/doc/tech/architecture.md | 7 +------ src/doc/tech/index.md | 6 +----- src/doc/tech/miscellaneous.md | 7 +++++-- 4 files changed, 8 insertions(+), 13 deletions(-) diff --git a/src/doc/mkdocs.yml b/src/doc/mkdocs.yml index a3bbbd2..a054a48 100644 --- a/src/doc/mkdocs.yml +++ b/src/doc/mkdocs.yml @@ -10,6 +10,7 @@ nav: - API: api/ - Architecture: architecture.md - Testing: testing.md + - CI/CD: https://github.com/vondacho/arch-blueprint-java/actions - Miscellaneous: miscellaneous.md plugins: diff --git a/src/doc/tech/architecture.md b/src/doc/tech/architecture.md index 4fc52b0..354691e 100644 --- a/src/doc/tech/architecture.md +++ b/src/doc/tech/architecture.md @@ -1,7 +1,4 @@ # Architecture -![build workflow](https://github.com/vondacho/arch-blueprint-java/actions/workflows/build.yml/badge.svg) - -A Java project as template and pedagogical support for the teaching of Clean Architecture crafting practice. ## C4 - [System context](https://www.structurizr.com/share/38199/diagrams#blueprint-context) @@ -13,6 +10,7 @@ Start the AppMap viewer on local port 3000 with `docker run -it -p 3000:8080 ghcr.io/vondacho/appmap-viewer:latest`. Then, visualize the behaviour of main use cases from the browser + - [E2E from API layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_adapter_rest_CustomerEndpointIT_shouldCreateAndModifyAndDeleteCustomer.appmap.json) - [E2E from Service layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_application_CustomerServiceIT_shouldCreateAndFindAndModifyAndRemoveACustomer.appmap.json) - [E2E from Data layer](http://localhost:3000/appmap/appmap.html?appmap=https://vondacho.github.io/arch-blueprint-java/appmap/edu_obya_blueprint_customer_adapter_jpa_CustomerRepositoryIT_shouldCreateAndFindAndModifyAndRemoveACustomer.appmap.json) @@ -32,6 +30,3 @@ ACL is used to protect the internal ubiquitous language from external languages. ## Data model ![Data model](../uml/data-model.svg) - -## CI/CD -[Github actions](https://github.com/vondacho/arch-blueprint-java/actions) diff --git a/src/doc/tech/index.md b/src/doc/tech/index.md index 11228f2..b8261ca 100644 --- a/src/doc/tech/index.md +++ b/src/doc/tech/index.md @@ -15,13 +15,9 @@ CRUD operations on Customer entities exposed by a REST API. ## Getting started - Build the project with `./gradlew clean build`. -- Launch the tests suite with `./gradlew clean check`. - Start the database with `docker-compose up`. - Launch the application with `./gradlew bootRun --args='--spring.profiles.active=test,jpa,postgres'`. -- Play use cases in Postman using [this default Postman collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json). - -## Release -Draft new release of the application from GitHub [release panel](https://github.com/vondacho/arch-blueprint-java/releases). +- Play use cases with Postman using [this default collection](https://vondacho.github.io/arch-blueprint-java/postman/postman_collection.json). ## This documentation - Powered by [MkDocs](https://www.mkdocs.org/getting-started/) diff --git a/src/doc/tech/miscellaneous.md b/src/doc/tech/miscellaneous.md index 982ff8b..52264cb 100644 --- a/src/doc/tech/miscellaneous.md +++ b/src/doc/tech/miscellaneous.md @@ -1,9 +1,12 @@ # Miscellaneous -## Technical documentation +## This documentation Build technical documentation with `./gradlew allureAggregateReport plantumlAll generateSwaggerUI mkdocsBuild`. ## AppMap resources Generate AppMap resources with `./gradlew appmap test`. -View your local AppMap resources following [this tutorial](https://github.com/vondacho/appmap-viewer#getting-started). \ No newline at end of file +View your local AppMap resources following [this tutorial](https://github.com/vondacho/appmap-viewer#getting-started). + +## Release +Draft new release of the application from GitHub [release panel](https://github.com/vondacho/arch-blueprint-java/releases).