Provide technical documentation creation procedures

[dwelsch-esi]

Overview

There is no documentation for website and tech doc content creation.

Audience: Documentation contributors

Type: Task

Context

This issue tracks recommended changes resulting from an analysis of the Vitess
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses/0014-vitess.

See the #1955 listing all issues identified in the analysis.

Possible Implementation

Related material in the current doc:

• Vitess website repo
• Vitess documentation

Suggested changes:

Write procedures for contributors to add and update information on
the product website and in the technical documentation. Such
procedures could include:

• Instructions for documenting tasks associated with new features
• Instructions for fixing documentation issues
• Templates for task write-ups and command references
• Guidelines for amending conceptual information with new features
• A style manual
• A review and approval process, separate from the code process
• A link from the code contribution instructions to the doc instructions
• A maintainer designated to be responsible for website maintenance and for
  documentation changes and updates
• Getting started instructions for new documentation contributors

In practice, open source projects rarely contain all this information. At a
minimum, document the following processes for contributors:

• Documenting a new release
  • Generating, testing, and deploying the new release docs, including how to
    publish release notes
  • Demoting, archiving, or deleting down-level releases
• Creating a doc issue
• Fixing and closing a doc issue
• How to contact the website and documentation maintainer with questions
• Getting started instructions for new documentation contributors

These processes should address documentation-specific concerns, not just repeat
the code release procedures (although there may be many of the same steps).