Documentation

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

• How-to guide
• Configuration
• Development and debugging

• Add a database query when models are not enough
• Add a language and choose its availability
• Adding and arranging questions

A version-specific record of changes compatibility concerns fixes and upgrade actions.

• Release notes

• 0.01.0
• 0.02.0
• 0.03.0

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

• Reference
• Server component
• Template validator

• acceptable_password
• acceptance
• addsite: Create a site application from a skeleton

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

• Explanation
• Authorization and access control
• Site management

• Choose a development tool
• Choose checks for a change
• Choose the site admin or the status site

A diagnostic document organized around symptoms causes checks and remedies.

• Troubleshooting
• Logging and monitoring
• Development and debugging

• A link is broken
• A module is discovered but not active
• A module is missing from the admin

A compact reusable solution that combines several Zotonic features for a recognizable situation.

• Cookbook recipe
• Erlang/OTP
• Forms

• Add a contact form
• Choose a destination after signup
• Complete module and function names in the shell

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

• Tutorial
• Erlang/OTP
• Development and debugging

• Add a supervised Erlang worker
• Create an Erlang application with Rebar3
• Create your first site

Documentation not covered by the other keyword groups in this split.

• ACL options
• Configuration
• Global configuration