Developer guide

A goal-oriented document that gives practical steps for a specific outcome.

• How-to guide
• Configuration
• Erlang/OTP

• Application startup and per-site module activation
• Build and start Zotonic
• Change a runtime setting deliberately

An information-oriented description of an API component option syntax or behavior.

• Reference

• addsite: Create a site application from a skeleton
• restart: Restart Zotonic and all sites within the current VM
• restartsite: Restart one site

An understanding-oriented document that explains concepts reasons architecture or trade-offs.

• Explanation
• Configuration
• Development and debugging

• Developer guide
• Find the configuration layer to change
• Installation and deployment

A learning-oriented document that guides a newcomer through a complete experience.

• Tutorial

• Create your first site
• Create your first site
• Set up a local development environment

A diagnostic document organized around symptoms causes checks and remedies.

• Troubleshooting

• A site does not start
• A site does not start