Repository files navigation

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.

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

The following branches are currently maintained:

For more information visit theDapr branch structure document.

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

The Dapr docs are built usingHugo with theDocsy theme, hosted on anAzure Static Web App.

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

This repository comes with adevcontainer configuration that automatically installs all the required dependencies and VSCode extensions to build and run the docs.

This devcontainer can be used to develop locally with VSCode or via GitHub Codespaces completely in the browser. Other IDEs that supportdevcontainers can be used but won't have the extensions preconfigured and will likely have different performance characteristics.

• Docker Desktop
• VSCode

1. Fork and clone this repository.

2. Open the forked repository in VS Code

code.

1. When prompted, click "Reopen in Container" to open the repository in the devcontainer.

Continue with theRun local server steps.

• Hugo extended version
• Node.js

1. Ensure pre-requisites are installed.

2. Fork and clone this repository.

3. Change to daprdocs directory:

cd ./daprdocs

4. Update submodules:

git submodule update --init --recursive

5. Install npm packages:

npm install

1. Make sure you're in thedaprdocs directory
2. Run

hugo server

3. Navigate tohttp://localhost:1313/

1. Ensure you are in your forked repo
2. Create new branch
3. Commit and push changes to forked branch
4. Submit pull request from downstream branch to the upstream branch for the correct version you are targeting
5. Staging site will automatically get created and linked to PR to review and test

Please refer to ourDapr community code of conduct.