Add new documentation topics and improve structure

Introduced new topics: Development and Liquibase, with details on setup and usage. Enhanced existing content in New Deployment and Database with links for better navigation. Updated the table of contents to reflect these changes and added a placeholder for publishing documentation instructions.
MichiBaum · Dec 24, 2024 · 6bac9d8 · 6bac9d8
1 parent 40098e5
commit 6bac9d8
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 4 deletions.
diff --git a/docs/Writerside/s.tree b/docs/Writerside/s.tree
@@ -7,13 +7,16 @@
                  start-page="Overview.md">
 
     <toc-element topic="Overview.md"/>
+    <toc-element topic="Development.md"/>
     <toc-element topic="Github.md">
         <toc-element topic="Actions.md"/>
     </toc-element>
     <toc-element topic="Server.md">
         <toc-element topic="New-Deployment.md"/>
     </toc-element>
-    <toc-element topic="Database.md"/>
+    <toc-element topic="Database.md">
+        <toc-element topic="Liquibase.md"/>
+    </toc-element>
     <toc-element topic="Services.md">
         <toc-element topic="Website-Service.md"/>
         <toc-element topic="Usermanagement-Service.md"/>

diff --git 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.
+Responsible to do a static code analysis.
+
+## publish-documentation.yml
+TODO https://www.jetbrains.com/help/writerside/deploy-docs-to-github-pages.html
diff --git 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
diff --git a/docs/Writerside/topics/Development.md 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
@@ -0,0 +1,3 @@
+# Liquibase
+
+Every Service that uses a Database has [liquibase](https://www.liquibase.com/).
diff --git 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.
+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).
diff --git a/docs/Writerside/topics/Website-Service.md b/docs/Writerside/topics/Website-Service.md
@@ -1,3 +1,2 @@
 # Website Service
 
-Start typing here...
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Liquibase

		Every Service that uses a Database has [liquibase](https://www.liquibase.com/).