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,527 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
Shubham Sharma 0889a11500
Add volume mount support to annotations reference (#2455) 
* Add docs to reference

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Trigger Build

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Add usage docs under operations

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Refactor

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Move the docs and add example

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Fix typo

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

* Incorporate review by @msfussell

Signed-off-by: Shubham Sharma <shubhash@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>
 		2022-06-08 15:18:00 -07:00
.github Update website-v1-8.yml 2022-04-07 17:54:08 -07:00
daprdocs Add volume mount support to annotations reference (#2455) 2022-06-08 15:18:00 -07:00
sdkdocs Upmerge of v1.7 into v1.8 20220518 (#2446) 2022-05-18 14:56:41 -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 updates to v1.7 for day of release (#2344) 2022-04-07 17:23:51 -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.7 (primary) https://docs.dapr.io Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.8 (pre-release) https://v1-8.docs.dapr.io/ Pre-release documentation. Doc updates that are only applicable to v1.8+ 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.