Suggested Dapr docs templates on Dapr Docs

Conceptual article template

Mon, 01 Jan 0001 00:00:00 +0000

Contributing a new conceptual or overview article

Conceptual (or overview) articles answer the questions:

Why should you care about this feature?
What problems does it help you solve?

While a component, API, or SDK spec may help readers understand how to use or work with these features, a conceptual article provides more depth and context. Link off to the spec article, but try not to simply repeat the spec.

When naming your conceptual article, make sure it is consistent with the spec in terms of names, parameters, and terminology. Make sure you update both as needed.

Quickstart guide template

Mon, 01 Jan 0001 00:00:00 +0000

Contributing a new quickstart guide

Dapr quickstart guides consist of quick instructions that walk readers through a prepared quickstart, saved to the dapr/quickstarts repo. These quickstarts package an entire feature or building block in one place, making it easy for the reader to experience how it works without compromising their own project.

The quickstart instructions should be succinct, direct, and clear. The sole purpose of a quickstart guide is to simply instruct a reader through the prepared quickstart. If you’d like to explain the concepts behind the quickstart, direct the reader to a concept article for more context.

How-to guide template

Mon, 01 Jan 0001 00:00:00 +0000

Contributing a new how-to guide

How-to guides provide step-by-step practical guidance to readers who wish to:

Enable a feature
Integrate a technology
Use Dapr in a specific scenario

How-to guides can be considered “next-level”, self-guided docs compared to quickstarts. How-to scenarios will take longer and can be more easily applied to the reader’s individual project or environment.

When naming your how-to document, include the sub-directory name in the file name. If you need to create a new sub-directory, make sure it’s descriptive and includes the relevant component or concept name. For example, pubsub-namespaces.