Dapr user documentation, used to build docs.dapr.io
Go to file
Aaron Crawfis e94125a158 Move mtls flags above examples 2020-12-11 18:21:06 -08:00
.github Update issue templates (#948) 2020-11-23 14:43:31 -08:00
OLD/presentations Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
daprdocs Move mtls flags above examples 2020-12-11 18:21:06 -08:00
.gitignore Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
.gitmodules Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
CODEOWNERS Create CODEOWNERS (#827) 2020-09-27 20:29:59 -07:00
CONTRIBUTING.md Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
LICENSE Addint MIT license (#101) 2019-10-08 17:32:59 -07:00
README.md Fixing README submodule instructions (#911) 2020-11-18 15:50:29 -08:00

README.md

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.

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

  1. Ensure pre-requisites are installed
  2. Clone this repository
git clone https://github.com/dapr/docs.git
  1. Change to daprdocs directory:
cd ./docs/daprdocs
  1. Update submodules:
git submodule update --init --recursive
  1. Install npm packages:
npm install

Run local server

  1. Make sure you're still in the daprdocs directory
  2. Run
hugo server --disableFastRender
  1. 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

Code of Conduct

Please refer to our Dapr community code of conduct.