sau-lanvy / docs

User documentation for Dapr

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

• Hugo extended version
• Node.js

Environment setup

1. Ensure pre-requisites are installed
2. Clone this repository

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

3. Change to daprdocs directory:

cd ./docs/daprdocs

4. Update submodules:

git submodule update --init --recursive

5. Install npm packages:

npm install

Run local server

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

Code of Conduct

Please refer to our Dapr community code of conduct.