About documentation for system administrators
Recall the goal of Awesign from the index page:
It's designed to be simple to use for content requesters and content managers, while modular and infinitely customizable for developers and system administrators.
This means that the initial configuration is fairly involved. Awesign is NOT a one-click-deploy solution. It will take some care to set up, but after the initial configuration, it shouldn't require much maintenance.
The documentation geared towards Awesign system administrators is brief. I assume you're an advanced technical user, so I won't explain everything from the ground up. This documentation will discuss anything particular to Awesign and quirks about Awesign, but you're expected to understand the underlying technologies that Awesign depends upon.
Secret documentation
There is additional administrator documentation provided in the docs/.internal directory of the GitHub repo for this
documentation. This directory includes slightly more sensitive UB/CSE-IT-specific documentation that shouldn't be made
public.
This includes:
- A full (super in-depth) installation guide and a version upgrade guide
- Information about tenant files during development and in production
- Client deployment guides
There are additional READMEs within the Awesign GitHub repository itself, which are mostly geared towards developers.