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
3,885 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
Hannah Hunter aa03902300
Upmerge - 9/21 (#2818) 
* feature/helmchart: supported private helm chart repo to install dapr cluster

Signed-off-by: 1046102779 <seachen@tencent.com>

* Updates wasm middleware documentation with compilation instructions

These changes are coupled with https://github.com/dapr/components-contrib/pull/1833

Signed-off-by: Adrian Cole <adrian@tetrate.io>

* Update daprdocs/content/en/reference/components-reference/supported-middleware/middleware-wasm.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com>

* feedback

Signed-off-by: Adrian Cole <adrian@tetrate.io>

* permute

Signed-off-by: Adrian Cole <adrian@tetrate.io>

* feature/helmchart: supported private helm chart repo to install dapr cluster

Signed-off-by: 1046102779 <seachen@tencent.com>

* add note to aws sns/sqs component doc; quick edit

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* change data to value

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* feature/helmchart: supported private helm chart repo to install dapr cluster

Signed-off-by: 1046102779 <seachen@tencent.com>

* Patch 3 (#2691)

* Update release version from 1.8.2 to 1.8.3

Signed-off-by: nyemade-uversky <55847877+nyemade-uversky@users.noreply.github.com>

* Update shortcode from 1.8.2 to 1.8.3

Signed-off-by: nyemade-uversky <55847877+nyemade-uversky@users.noreply.github.com>

* fix: typo

Signed-off-by: 1046102779 <seachen@tencent.com>

* feature: add a private helm repo for dapr

Signed-off-by: 1046102779 <seachen@tencent.com>

* Update install-dapr-cli.md

Signed-off-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>

* Update daprdocs/content/en/operations/hosting/kubernetes/kubernetes-deploy.md

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Signed-off-by: yellow chicks <seachen@tencent.com>

* Fix pubsub quickstart component name to match QS source code

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* add output of success

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove word

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* add sentence

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* redis 6 update (#2718)

Signed-off-by: yaron2 <schneider.yaron@live.com>

Signed-off-by: yaron2 <schneider.yaron@live.com>

* Update Dapr version to 1.8.4 (#2714)

* Update Dapr version to 1.8.4

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* Update CLI version to 1.8.1

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* Fixed an issue with code highlighting

Signed-off-by: Lorenzo Montanari <l0ll098@users.noreply.github.com>

* Fix links to broken middleware components

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* RethinkDB has no transactions, etags

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* fix a typo (#2748)

Signed-off-by: Loong <loong.dai@intel.com>

Signed-off-by: Loong <loong.dai@intel.com>

* fix typo (#2751)

Signed-off-by: RcXu <honeyxhl@163.com>

Signed-off-by: RcXu <honeyxhl@163.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update component status in v1.7

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Mark components as stable in v1.8

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Correct state azure stablestorage status in v1.7

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Update setup-sqlserver.md

Signed-off-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>

* fix some typos (#2765)

Signed-off-by: Loong <loong.dai@intel.com>

Signed-off-by: Loong <loong.dai@intel.com>

* Typo fix installtion > installation (#2726)

Signed-off-by: Greg. A. <gautric@users.noreply.github.com>

Signed-off-by: Greg. A. <gautric@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Add a new version of the Dapr Diagrams deck (#2773)

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* Fix typos in MongoDB state configuration file example (#2775)

Closes https://github.com/dapr/docs/issues/2774

Signed-off-by: Yash Nisar <yashnisar@microsoft.com>

Signed-off-by: Yash Nisar <yashnisar@microsoft.com>

* update service invo row item

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update az cli commands

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove unnecessary flags

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* ignore links

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Fix broken link

Signed-off-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>

* Fix broken link

Signed-off-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>

* remove ignore links

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* java submodule

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Fix two typo's (#2812)

Signed-off-by: Maarten Mulders <mthmulders@users.noreply.github.com>

Signed-off-by: Maarten Mulders <mthmulders@users.noreply.github.com>

Signed-off-by: 1046102779 <seachen@tencent.com>
Signed-off-by: Adrian Cole <adrian@tetrate.io>
Signed-off-by: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com>
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: nyemade-uversky <55847877+nyemade-uversky@users.noreply.github.com>
Signed-off-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Signed-off-by: yellow chicks <seachen@tencent.com>
Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>
Signed-off-by: yaron2 <schneider.yaron@live.com>
Signed-off-by: Lorenzo Montanari <l0ll098@users.noreply.github.com>
Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>
Signed-off-by: Loong <loong.dai@intel.com>
Signed-off-by: RcXu <honeyxhl@163.com>
Signed-off-by: Greg. A. <gautric@users.noreply.github.com>
Signed-off-by: Yash Nisar <yashnisar@microsoft.com>
Signed-off-by: Maarten Mulders <mthmulders@users.noreply.github.com>
Co-authored-by: 1046102779 <seachen@tencent.com>
Co-authored-by: Adrian Cole <adrian@tetrate.io>
Co-authored-by: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: nyemade-uversky <55847877+nyemade-uversky@users.noreply.github.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>
Co-authored-by: Nick Greenfield <nigreenf@microsoft.com>
Co-authored-by: Lorenzo Montanari <l0ll098@users.noreply.github.com>
Co-authored-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>
Co-authored-by: Loong Dai <loong.dai@intel.com>
Co-authored-by: Mr.Black <honeyxhl@163.com>
Co-authored-by: Greg. A <gautric@users.noreply.github.com>
Co-authored-by: Yash Nisar <yashnisar@microsoft.com>
Co-authored-by: Maarten Mulders <mthmulders@users.noreply.github.com>
 		2022-09-23 08:59:38 -07:00
.github Update workflow and config.toml for v1.9 2022-07-07 15:51:55 -07:00
daprdocs Upmerge - 9/21 (#2818) 2022-09-23 08:59:38 -07:00
sdkdocs Upmerge - 9/21 (#2818) 2022-09-23 08:59:38 -07:00
translations Upmerge2 06 03 (#1536) 2021-06-03 10:25:39 -07:00
.gitignore Bindings commercetools (#2363) 2022-05-12 15:28:14 -07:00
.gitmodules Update JS submodule 2021-09-21 09:07:36 -07:00
CONTRIBUTING.md Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
LICENSE Updating LICENSE to Creative Commons Attribution 4.0 International 2021-11-17 14:00:29 -08:00
README.md 1.8 release 2022-07-06 14:03:05 -05: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.8 (primary) https://docs.dapr.io Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.9 (pre-release) https://v1-9.docs.dapr.io/ Pre-release documentation. Doc updates that are only applicable to v1.9+ 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 ./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.