Improve documentation - Githubissues

osxhacker / demo-microsite

An exploration of microsite/microservice concepts.

BSD 3-Clause "New" or "Revised" License

2 stars 0 forks source link

Improve documentation #1

Closed osxhacker closed 1 year ago

osxhacker commented 1 year ago

The project README currently contains only the GitHub-generated content. It needs to be finished to include:

[x] An introduction describing the goals of this project.
[x] A roadmap of where further documentation can be found.
[x] A high-level system architecture diagram.
[x] A "further reading" section.

Additionally:

[x] Define an ADR to capture security decisions.
[x] Add links to each frontends service README for its REST entry point XML definition.
[x] Update the gatling README to show use of the run-load-test.sh script.
[x] Update deployment/docker README to document service IP port allocation.