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
950 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
Ajay Singh a80c5df051
Update install-dapr.md (#909) 
After installing dapr on Kubernetes total of 5 pods got provisioned. One dashboard pod entry is missing in doc. 
In previous docs, this request was got accepted seems it got missed again.

Co-authored-by: Ori Zohar <orzohar@microsoft.com>
 		2020-11-13 15:48:24 -08:00
.github Add skip upload if missing token (#913) 2020-11-13 10:53:38 -08:00
OLD/presentations Merge branch 'master' into website 2020-10-26 09:05:11 -07:00
daprdocs Update install-dapr.md (#909) 2020-11-13 15:48:24 -08:00
.gitignore Upadted git ignore for package lock 2020-09-16 10:35:35 -07:00
.gitmodules Initial configuration of hugo and docsy 2020-09-14 15:15:29 -07:00
CODEOWNERS Merge master 2020-10-01 15:51:04 -07:00
CONTRIBUTING.md Updating contributing section 2020-10-23 18:34:12 -07:00
LICENSE Addint MIT license (#101) 2019-10-08 17:32:59 -07:00
README.md Update README.md 2020-10-23 18:40:52 -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.

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. Add Docsy submodule:
git submodule add https://github.com/google/docsy.git themes/docsy
  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/docs

Update docs

  1. Create new branch
  2. Commit and push changes to content
  3. Submit pull request to master
  4. 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.