hostsharing/hs.hsadmin.ng
6
0
Fork 0
Code Pull Requests 1 Activity

re-generate TOC of README.md

Browse Source
This commit is contained in:
Michael Hoennig 2025-01-21 14:09:11 +01:00
parent 0e29958bf9
commit 56bc47dc95
1 changed files with 40 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -27,7 +27,13 @@ For architecture consider the files in the `doc` and `adr` folder.
- [OWASP Security Vulnerability Check](#owasp-security-vulnerability-check) - [OWASP Security Vulnerability Check](#owasp-security-vulnerability-check)
- [Dependency-License-Compatibility](#dependency-license-compatibility) - [Dependency-License-Compatibility](#dependency-license-compatibility)
- [Dependency Version Upgrade](#dependency-version-upgrade) - [Dependency Version Upgrade](#dependency-version-upgrade)
- [Biggest Flaws in our Architecture](#biggest-flaws-in-our-architecture)
- [The RBAC System is too Complicated](#the-rbac-system-is-too-complicated)
- [The Mapper is Error-Prone](#the-mapper-is-error-prone)
- [Too Many Business-Rules Implemented in Controllers](#too-many-business-rules-implemented-in-controllers)
- [How To ...](#how-to-...) - [How To ...](#how-to-...)
- [How to Run the Application With Other Profiles, e.g. production](#)
- [How to Do a Clean Run of the Application](#how-to-do-a-clean-run-of-the-application)
- [How to Configure .pgpass for the Default PostgreSQL Database?](#how-to-configure-.pgpass-for-the-default-postgresql-database?) - [How to Configure .pgpass for the Default PostgreSQL Database?](#how-to-configure-.pgpass-for-the-default-postgresql-database?)
- [How to Run the Tests Against a Local User-Space Podman Daemon?](#how-to-run-the-tests-against-a-local-user-space-podman-daemon?) - [How to Run the Tests Against a Local User-Space Podman Daemon?](#how-to-run-the-tests-against-a-local-user-space-podman-daemon?)
- [Install and Run Podman](#install-and-run-podman) - [Install and Run Podman](#install-and-run-podman)
@ -40,6 +46,7 @@ For architecture consider the files in the `doc` and `adr` folder.
- [How to Amend Liquibase SQL Changesets?](#how-to-amend-liquibase-sql-changesets?) - [How to Amend Liquibase SQL Changesets?](#how-to-amend-liquibase-sql-changesets?)
- [How to Re-Generate Spring-Controller-Interfaces from OpenAPI specs?](#how-to-re-generate-spring-controller-interfaces-from-openapi-specs?) - [How to Re-Generate Spring-Controller-Interfaces from OpenAPI specs?](#how-to-re-generate-spring-controller-interfaces-from-openapi-specs?)
- [How to Generate Database Table Diagrams?](#how-to-generate-database-table-diagrams?) - [How to Generate Database Table Diagrams?](#how-to-generate-database-table-diagrams?)
- [How to Add (Real) Admin Users](#how-to-add-(real)-admin-users)
- [Further Documentation](#further-documentation) - [Further Documentation](#further-documentation)
<!-- generated TOC end. --> <!-- generated TOC end. -->
@ -205,7 +212,7 @@ To generate the TOC (Table of Contents), a little bash script from a
Given this is in PATH as `md-toc`, use: Given this is in PATH as `md-toc`, use:
```shell ```shell
md-toc <README.md 2 4 | cut -c5-' md-toc <README.md 2 4 | cut -c5-
``` ```
To render the Markdown files, especially to watch embedded PlantUML diagrams, you can use one of the following methods: To render the Markdown files, especially to watch embedded PlantUML diagrams, you can use one of the following methods: