dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Ori Zohar 2020-10-23 18:40:52 -07:00 committed by GitHub
parent 4b61351a7c
commit d848239f53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -2,17 +2,17 @@
If you are looking to explore the Dapr documentation, please go to the documentation website: If you are looking to explore the Dapr documentation, please go to the documentation website:
## [docs.dapr.io](https://docs.dapr.io) [**https://docs.dapr.io**](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. 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 ## Contribution guidelines
Before making your first contribution, make sure to review the ["Contributing"](http://docs.dapr.io/contributing/) section in the docs. Before making your first contribution, make sure to review the [contributing section](http://docs.dapr.io/contributing/) in the docs.
## Overview ## Overview
The Dapr docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted on an [Azure static web app](https://docs.microsoft.com/en-us/azure/static-web-apps/overview). The Dapr docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted on an [Azure Static Web App](https://docs.microsoft.com/en-us/azure/static-web-apps/overview).
The [daprdocs](./daprdocs) directory contains the hugo project, markdown files, and theme configurations. The [daprdocs](./daprdocs) directory contains the hugo project, markdown files, and theme configurations.
@ -24,34 +24,34 @@ The [daprdocs](./daprdocs) directory contains the hugo project, markdown files,
## Environment setup ## Environment setup
1. Ensure pre-requisites are installed 1. Ensure pre-requisites are installed
1. Clone this repository 2. Clone this repository
```sh ```sh
git clone https://github.com/dapr/docs.git git clone https://github.com/dapr/docs.git
``` ```
1. Change to daprdocs directory: 3. Change to daprdocs directory:
```sh ```sh
cd daprdocs` cd daprdocs
``` ```
1. Add Docsy submodule: 4. Add Docsy submodule:
```sh ```sh
git submodule add https://github.com/google/docsy.git themes/docsy git submodule add https://github.com/google/docsy.git themes/docsy
``` ```
1. Update submodules: 5. Update submodules:
```sh ```sh
git submodule update --init --recursive git submodule update --init --recursive
``` ```
1. Install npm packages: 6. Install npm packages:
```sh ```sh
npm install npm install
``` ```
## Run local server ## Run local server
1. Make sure you're still in the `daprdocs` directory 1. Make sure you're still in the `daprdocs` directory
1. Run 2. Run
```sh ```sh
hugo server --disableFastRender hugo server --disableFastRender
``` ```
1. Navigate to `http://localhost:1313/docs` 3. Navigate to `http://localhost:1313/docs`
## Update docs ## Update docs
1. Create new branch 1. Create new branch
@ -60,4 +60,4 @@ hugo server --disableFastRender
1. Staging site will automatically get created and linked to PR to review and test 1. Staging site will automatically get created and linked to PR to review and test
## Code of Conduct ## Code of Conduct
Please refer to our [Dapr community code of conduct](https://github.com/dapr/community/blob/master/CODE-OF-CONDUCT.md) Please refer to our [Dapr community code of conduct](https://github.com/dapr/community/blob/master/CODE-OF-CONDUCT.md).