diff --git a/docs/Writerside/s.tree b/docs/Writerside/s.tree index 970452d2..17c12ef5 100644 --- a/docs/Writerside/s.tree +++ b/docs/Writerside/s.tree @@ -7,13 +7,16 @@ start-page="Overview.md"> + - + + + diff --git a/docs/Writerside/topics/Actions.md b/docs/Writerside/topics/Actions.md index 8ab82c04..4d95ac2b 100644 --- a/docs/Writerside/topics/Actions.md +++ b/docs/Writerside/topics/Actions.md @@ -16,4 +16,7 @@ Responsible to label pull requests with what has changed. Google OSV scanner is responsible to find dependencies that are vulnerable. ## sonarqube.yml (SonarQube Analysis) -Responsible to do a static code analysis. \ No newline at end of file +Responsible to do a static code analysis. + +## publish-documentation.yml +TODO https://www.jetbrains.com/help/writerside/deploy-docs-to-github-pages.html \ No newline at end of file diff --git a/docs/Writerside/topics/Database.md b/docs/Writerside/topics/Database.md index 2f42ce7b..fa3a9bd3 100644 --- a/docs/Writerside/topics/Database.md +++ b/docs/Writerside/topics/Database.md @@ -1,5 +1,8 @@ # Database +## Updates +To update database's table, columns or anything [liquibase](Liquibase.md) is used. + ## Backup \ No newline at end of file diff --git a/docs/Writerside/topics/Development.md b/docs/Writerside/topics/Development.md new file mode 100644 index 00000000..9a0970e7 --- /dev/null +++ b/docs/Writerside/topics/Development.md @@ -0,0 +1,32 @@ +# Development + +Requirements: +- Java 23 installed +- Npm installed (lts is best) +- [Update hosts file]() + + + +## Update hosts file +*Remember to take Backup before editing your `hosts` file, mistakes there can block your internet access or cause other network-related issues.* + + +### Windows +You need Administrator access to update hosts. +In ``C:\Windows\System32\drivers\etc`` find file *hosts* and add those lines: + +``` +# Microservices +127.0.0.1 chess.michibaum.ch +127.0.0.1 gateway.michibaum.ch +127.0.0.1 registry.michibaum.ch +127.0.0.1 admin.michibaum.ch +127.0.0.1 usermanagement.michibaum.ch +127.0.0.1 authentication.michibaum.ch +127.0.0.1 fitness.michibaum.ch +127.0.0.1 music.michibaum.ch +127.0.0.1 michibaum.ch +``` + +### Linux +In Linux the file is located under ``/etc/hosts``. diff --git a/docs/Writerside/topics/Liquibase.md b/docs/Writerside/topics/Liquibase.md new file mode 100644 index 00000000..d0192a34 --- /dev/null +++ b/docs/Writerside/topics/Liquibase.md @@ -0,0 +1,3 @@ +# Liquibase + +Every Service that uses a Database has [liquibase](https://www.liquibase.com/). \ No newline at end of file diff --git a/docs/Writerside/topics/New-Deployment.md b/docs/Writerside/topics/New-Deployment.md index 916c1398..29fd6e6a 100644 --- a/docs/Writerside/topics/New-Deployment.md +++ b/docs/Writerside/topics/New-Deployment.md @@ -1,3 +1,3 @@ # New Deployment -Every new Deployment is first startet with a pull request and merge into the master branch. This triggers multiple Github actions. One ot these is Build and Publish. \ No newline at end of file +Every new Deployment is first startet with a pull request and merge into the master branch. This triggers multiple Github actions. One ot these is [Build and Publish](Actions.md#deploy-yml-build-and-publish). \ No newline at end of file diff --git a/docs/Writerside/topics/Website-Service.md b/docs/Writerside/topics/Website-Service.md index 5d0d8be0..ae4e96ae 100644 --- a/docs/Writerside/topics/Website-Service.md +++ b/docs/Writerside/topics/Website-Service.md @@ -1,3 +1,2 @@ # Website Service -Start typing here... \ No newline at end of file