dapr-docs's Introduction

Dapr documentation

If you are looking to explore the Dapr documentation, please go to the documentation website:

https://docs.dapr.io

This repo contains the markdown files which generate the above website. See below for guidance on running with a local environment to contribute to the docs.

Branch guidance

The Dapr docs handles branching differently than most code repositories. Instead of having a master or main branch, every branch is labeled to match the major and minor version of a runtime release.

The following branches are currently maintained:

Branch	Website	Description
v1.9 (primary)	https://docs.dapr.io	Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.10 (pre-release)	https://v1-10.docs.dapr.io/	Pre-release documentation. Doc updates that are only applicable to v1.10+ go here.

For more information visit the Dapr branch structure document.

Contribution guidelines

Before making your first contribution, make sure to review the contributing section in the docs.

Overview

The Dapr docs are built using Hugo with the Docsy theme, hosted on an Azure Static Web App.

The daprdocs directory contains the hugo project, markdown files, and theme configurations.

Pre-requisites

Environment setup

Ensure pre-requisites are installed
Clone this repository

git clone https://github.com/dapr/docs.git

Change to daprdocs directory:

cd ./daprdocs

Update submodules:

git submodule update --init --recursive

Install npm packages:

npm install

Run local server

Make sure you're still in the daprdocs directory
Run

hugo server

Navigate to http://localhost:1313/

Update docs

Fork repo into your account
Create new branch
Commit and push changes to forked branch
Submit pull request from downstream branch to the upstream branch for the correct version you are targeting
Staging site will automatically get created and linked to PR to review and test