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
1,456 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
Phil Kedy bbc10f8b4d
Restructuring middleware docs pages (#1190) 
* First pass at restructuring the middleware docs pages

* Tweaks

* Updating custom middleware instructions.
Grammatical tweak re: secrets in metadata values.

* Adding descriptions for each middleware component to the supported middleware table

* Table allignment

* Various tweaks

* its versus it's

* Making Quickstart capitalized again

* Better OAuth spec links for the two grant flows currently supported

* Fixing two sentences

* Update middleware-overview.md

* Update middleware-bearer.md

* Update middleware-oauth2.md

* Update middleware-oauth2clientcredentials.md

* Update middleware-opa.md

* Update middleware-rate-limit.md

* Update middleware-uppercase.md

* Update middleware-rate-limit.md

* Update middleware-opa.md

* Update middleware-oauth2.md

* Update middleware-bearer.md

* Update middleware-oauth2.md

* Update middleware-bearer.md

* Update middleware-oauth2clientcredentials.md

* Update middleware-opa.md

* Update middleware-rate-limit.md

* Update middleware-uppercase.md

* Update daprdocs/content/en/developing-applications/middleware/supported-middleware/middleware-oauth2clientcredentials.md

Co-authored-by: Mukundan Sundararajan <musundar@microsoft.com>

* Update daprdocs/content/en/developing-applications/middleware/supported-middleware/middleware-rate-limit.md

Co-authored-by: Mukundan Sundararajan <musundar@microsoft.com>

* Update daprdocs/content/en/developing-applications/middleware/supported-middleware/middleware-opa.md

Co-authored-by: Mukundan Sundararajan <musundar@microsoft.com>

* Update daprdocs/content/en/developing-applications/middleware/middleware-overview.md

Co-authored-by: Mukundan Sundararajan <musundar@microsoft.com>

* Tweaks per PR

* Small tweak

* Small tweak

Co-authored-by: Mark Fussell <mfussell@microsoft.com>
Co-authored-by: Mukundan Sundararajan <musundar@microsoft.com>
Co-authored-by: Ori Zohar <orzohar@microsoft.com>
 		2021-02-12 16:25:24 -08:00
.github Update azure-static-web-apps-black-water-03a7ce11e.yml 2021-02-02 12:01:07 -08:00
OLD/presentations Migrate to new Dapr docs site (#880) 2020-10-26 11:37:44 -07:00
daprdocs Restructuring middleware docs pages (#1190) 2021-02-12 16:25:24 -08:00
sdkdocs Switch to master branch 2021-01-19 15:22:00 -08:00
.gitignore Mysql output binding doc (#1111) 2021-01-26 11:06:50 -08:00
.gitmodules Add Python submodule 2020-12-16 13:17:52 -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 Removing notes and updating versions in commands 2021-02-10 16:58:46 -08: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.0 (primary) https://docs.dapr.io Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.1 (pre-release) https://v1-1.docs.dapr.io/ Pre-release documentation. Doc updates that are only applicable to v1.1+ 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 --disableFastRender
  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.