Skip to content

Update Contributing to Docs with information about Quick Start guides #12290

@inventarSarah

Description

@inventarSarah

Problem Statement

Update "Contributing to docs":

  • inform about differences between a quick start and a getting started guide;
    • why: helps writers decide which guide fits their current documentation goal; provides background information on why we decided to convert the original SDK Getting Started Guides into Quick Start Guides
  • create How to Write - Quick Start guides (or update existing getting started - to be checked)
    • why: provides guidelines, best practices, and templates that help writers create this type of content

Solution Brainstorm

We can do that once we've created a quick start guide for manual installation and one for wizard installation and are happy with the results.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions