231b0e8fb3
* Add consul references * Fix typo Add a missing word * Clarify state management examples * Added table to show Kubernetes options When I read this doc it was unclear that the cert could be provided as a secret. The only table on the original version showed `spnCertificateFile` as a required option. I added a second table to make it clear that in Kubernetes there is a `spnCertificate` option that does not require a file on disk. * incorporating feedback * Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md * Update daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md * Fix self-hosted docs * Remove name-resolution reference * Add other name resolution providers * Update service invocation docs * Remove whitespace * Update service-invocation-overview.md Fixed typo and added a sentence on Consul * Update setup-nr-consul.md Minor updates * Address comments * Fix code formatting Co-authored-by: Esteban Luchsinger <eluchsingerm@hotmail.com> Co-authored-by: Donovan Brown <dbrown@microsoft.com> Co-authored-by: Mark Fussell <mfussell@microsoft.com> |
||
|---|---|---|
| .github | ||
| daprdocs | ||
| sdkdocs | ||
| translations | ||
| .gitignore | ||
| .gitmodules | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
README.md
Dapr documentation
If you are looking to explore the Dapr documentation, please go to the documentation website:
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.2 (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
| v1.3 (pre-release) | https://v1-3.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.3+ 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 ./docs/daprdocs
- Update submodules:
git submodule update --init --recursive
- Install npm packages:
npm install
Run local server
- Make sure you're still in the
daprdocsdirectory - 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
Code of Conduct
Please refer to our Dapr community code of conduct.