Skip to content

Clean up GitHub issues #1988

@dwelsch-esi

Description

@dwelsch-esi

Overview

There are dozens of issues open against the Vitess documentation, going back to 2018.
Improve documentation issue handling by cleaning up old issues and implementing procedures.

Audience: Documentation contributors

Type: All

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:

Suggested changes:

  • Go through the issues backlog and close or update old issues.
  • Create an issue template to ensure that issue descriptions are consistent and
    complete.
  • Write a "new contributors" document. Post prominently.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions