dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Dapr user documentation, used to build docs.dapr.io
2,033 Commits 65 Branches 11 Tags 386 MiB
HTML 78.3%
SCSS 16.8%
JavaScript 2.4%
Python 2.3%
Shell 0.2%
Go to file
Aaron Crawfis 55d9123cfe
upmerge/06-24 (#1588) 
* Supported Release Info and Upgrade Path for v1.2 (#1494)

* Supported Release Info and Upgrade Path for v1.2

* Update support-release-policy.md

* Update daprdocs/content/en/operations/support/support-release-policy.md

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Adding K8s versions table (#1521)

* Adding table of kubernetes versions

* Updating intro

* Fix incorrect postgresql connection string example (#1524)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Update docs on using Codespaces with Dapr repos (#1522)

* Update docs on using Codespaces with Dapr repos

* Move codespaces.md under the Contributing topic

* Update daprdocs/content/en/contributing/codespaces.md

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Fix two typos (#1526)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Update chinese content (#1527)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Updated to fix deprecated helm chart location (#1528)

The `https://kubernetes-charts.storage.googleapis.com/` location is no longer used, so this change updates this, the command to install, and the missing update step that will cause the install to fail if an update was never done after adding the location.

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* nr_consul_typo fixed malformed yaml (#1532)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Fix typo in azure-keyvault-managed-identity.md (#1541)

* Fix custom middleware sample code interface implementation error (#1539)

Fix custom middleware sample code interface implementation error, interface function declare error.

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Fix the file name of secrets json (#1546)

* Tech writing touch-ups (#1555)

* Tech writing touch-ups (#1556)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Tech writing touch-ups (#1557)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Tech writing touch-ups (#1558)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Tech writing touch-ups (#1560)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Tech writing touch-ups (#1559)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Ignore intellij link that isn't resolvable (#1564)

* Update issue templates (#1563)

* Update issue templates

* Add needs-triage

* Updating PubSub documentation to remove slave wording (#1565)

* Updating PubSub documentation to remove slave

Bitnami has updated their Redis Helm chart to change redis-slave to redis-replicas. I am updating the documentation for PubSub to reflect this change and avoid confusion for any readers.

* Removing more instances of Redis slave naming

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Actor Runtime Configuration Docs (#1495)

* Actor Runtime Configuration Docs

Addresses #1470

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* add configuration examples

* configuration examples

* Fix syntax

* Add dotnet sample

* Update daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors.md

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Fixed GCP Pub/Sub Binding required fields (#1578)

* aacrawfi/middlware (#1567)

* Move and update middleware components

* Update middleware docs structure

* Combine middleware pages

* Update middleware references

* Update middleware image

* Fix incorrect curl syntax in Actors API examples (#1577)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Fix link at api-allowlist.md (#1574)

Fix link at api-allowlist.md to Dapr Configuration overview

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* Add language that only a single state store component can be used for actors state mangement (#1579)

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

* fix: cron format (#1581)

* Updated name resolution docs (#1576)

* 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>

Co-authored-by: Bernd Verst <berndverst@users.noreply.github.com>
Co-authored-by: Mark Fussell <mfussell@microsoft.com>
Co-authored-by: Zonciu Liang <zonciu@zonciu.com>
Co-authored-by: Simon Leet <31784195+CodeMonkeyLeet@users.noreply.github.com>
Co-authored-by: Maarten Mulders <mthmulders@users.noreply.github.com>
Co-authored-by: Newbe36524 <newbe36524@qq.com>
Co-authored-by: Steven Jenkins De Haro <20492442+StevenJDH@users.noreply.github.com>
Co-authored-by: Abdulaziz Elsheikh <abdulaziz.elsheikh@gmail.com>
Co-authored-by: Antonio Fiumanò <antoniofiumano@outlook.com>
Co-authored-by: li1234yun <li1234yun@163.com>
Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: voipengineer <voipengineer@users.noreply.github.com>
Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
Co-authored-by: Ricardo Niepel <RicardoNiepel@users.noreply.github.com>
Co-authored-by: Abhith Rajan <Abhith@users.noreply.github.com>
Co-authored-by: Esteban Luchsinger <eluchsingerm@hotmail.com>
Co-authored-by: Donovan Brown <dbrown@microsoft.com>
 		2021-06-24 17:50:12 -07:00
.github Upmerge/6 16 (#1570) 2021-06-16 13:42:37 -07:00
daprdocs upmerge/06-24 (#1588) 2021-06-24 17:50:12 -07:00
sdkdocs Update SDK-Docs 2021-04-01 10:27:27 -07:00
translations Upmerge2 06 03 (#1536) 2021-06-03 10:25:39 -07:00
.gitignore Mysql output binding doc (#1111) 2021-01-26 11:06:50 -08:00
.gitmodules Change name of submodule 2021-03-05 12:09:35 +08: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 Update to 1.2 (#1519) 2021-05-26 18:40:25 -07: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.

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

  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
  1. Navigate to http://localhost:1313/

Update docs

  1. Fork repo into your account
  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

Code of Conduct

Please refer to our Dapr community code of conduct.