---
# System prepended metadata

title: Docmentation layout

---

# Docmentation layout

This document describes a layout for EZID application documentation. The plan is to use a static site generator such as Sphinx to (initially at least) provide technical documentation.


```
Technical documentation
- Architecture
    Components and their interactions      
- Operation
    Focus on EZID manager / operator
- Administration
    Hardware, infrastructure dependencies
    Installation
    Upgrades
    Monitoring
    Start up, shutdown
    Backup
    Who to call
- APIs and services
- Development
- Changelog
```

* Either Confluence for private / sensitive information or use public and private repos
* UC3 System Inventory Tool holds all the specifics of hosts, etc
* Hosting can be GitHub pages, Read The Docs, or hosted by EZID itself.
* Code examples should as far as possible execute when the docs build to verify the examples are accurate and to include output
* For theme and branding, choose an existing theme close to current EZID docs and add custom css etc later as needed.
* documentation sources can use markdown or restructured text markup formats.
* Changelog can point to https://github.com/CDLUC3/ezid/releases