Dapr Documentation Repo

This repo contains the markdown files which generate the Dapr documentation site over at https://docs.dapr.io. Head over there to read the docs and get started with Dapr! Read on to get up and running with a local environment to contribute to 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

• Hugo extended version
• Node.js

Environment setup

1. Ensure pre-requisites are installed
2. Clone repository
3. Change to daprdocs directory: cd daprdocs
4. Add Docsy submodule: git submodule add https://github.com/google/docsy.git themes/docsy
5. Update submodules: git submodule update --init --recursive
6. Install npm packages: npm install

Run local server

1. Make sure you're still in the daprdocs repo
2. Run hugo server --disableFastRender
3. Navigate to http://localhost:1313/docs

Update docs

1. Create new branch
2. Commit and push changes to content
3. Submit pull request to master
4. Staging site will automatically get created and linked to PR to review and test