Janssen Documentation

The full documentation for the Janssen Project is in progress.

This is the main repo for Janssen Project documentation. Each project may have a few types of docs:

1. Architecture / Feature Overview: A high level overview of what the component is supposed to do and how it works.
2. API Reference: An OpenAPI document which can be viewed with SwaggerUI
3. Code Reference: These are auto-generated docs that are extracted from the code, for example, Javadocs.
4. Deployment Reference: Instructions on how to properly deploy this component. Included are what persistence, caching, file system, network (e.g. port), compute or other system requirements are needed to make it run.
5. Data Reference: If the component needs a database or cache, an overview of the required schema or information tree.
6. Developer Reference: Want to help develop this component? This reference will tell you how to build, setup your IDE, align with best practices, and other things you'll need to know to join the team.
7. Test Reference: How to run unit tests, integration tests, performance tests, or any other kind of tests to make sure this component is running properly.
8. User guide: How to use the software? This can be administration tasks or end user functionality.
9. Security Considerations: What you need to know to operate the component securely, including best practices.