Dapr user documentation, used to build docs.dapr.io
Go to file
loopFY 33d756f8f8
adding Read buffer size argument to fasthttp server and grpc server (#2263)
* adding Read buffer size argument to fasthttp server and grpc server dapr/dapr#3346

By making a contribution to this project, I certify that:
    (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
    (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
    (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
    (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

This is my commit message
Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* added introduction to dapr-http-read-buffer-size

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Modify the note description

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Adding read buffer size argument to fasthttp server and grpc server

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Added introduction to dapr-http-read-buffer-size

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Modify the note description

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Modify this description

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Add a detailed description

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Make the appropriate title changes

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

* Modification introduction and corresponding instructions

Signed-off-by: Fang Yuan <wojiushifangyuanlove@gmail.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>
2022-03-31 21:51:56 -07:00
.github Release v1.6 (Day of release changes to v1.6) 2022-01-21 11:29:01 -08:00
daprdocs adding Read buffer size argument to fasthttp server and grpc server (#2263) 2022-03-31 21:51:56 -07:00
sdkdocs Update JS sdk submodule which will bring in doc changes to use http and not grpc 2022-02-10 09:00:01 -08:00
translations Upmerge2 06 03 (#1536) 2021-06-03 10:25:39 -07:00
.gitignore Update docs for Event Hubs pubsub 2022-01-20 23:51:25 +05:30
.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 Release v1.6 (Day of release changes to v1.6) 2022-01-21 11:29:01 -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.6 (primary) https://docs.dapr.io Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.7 (pre-release) https://v1-7.docs.dapr.io/ Pre-release documentation. Doc updates that are only applicable to v1.7+ 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.