Documentation on writing deployment guides or recipes

[zackkrida]

Problem

Users often need guidance on configuring Mathesar to work in a variety of different production contexts: cloud platforms, self-hosted infrastructure, and integrations with other tools.

Publishing guides (step-by-step tutorials on deploying Mathesar in a particular context) and something like "recipes" (configuration code snippets) to https://docs.mathesar.org will help users deploy Mathesar in common scenarios and reduce the need for direct, individualized user support.

Before this content is written, it would be useful to offer advice to documentation authors on how to write it.

Proposed solution

To improve the quality of this documentation and its usefulness to users, we should document standards and recommendations for writing guides and recipes. These guidelines should also be published in the the docs site, colocated with the guides themselves, and should offer suggestions on, for example:

• Acceptance criteria for guides and recipes, for example:
  • Is this a general-purpose use case that will appeal to other users?
  • Does the guide follow the conventions/proper use of the deployment cloud platform or hardware?
  • If it is a more niche guide (for example, deploying Mathesar to a Synology NAS), will the content go out of date quickly?
  • Is there existing "prior art" elsewhere on the web that, while more general purpose, does a sufficient job of covering a given use case?
• How to structure guides and recipes
• Where and in what format to publish these materials (i.e, markdown files in a particular directory, not new Dockerfiles added to the application)

Additional context