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,919 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
Tiago Alves Macambira 8f08e681df
Update SecretStore API documentation to account for Features feature. (#2863) 
* Update SecretStore API documentation to account for Features feature.

Updates secret stores data/components and partial HTML fragment to
account for this new feature, updating the table of supported secret
stores.

Updates Secret Store API page to refer to this feature in the secret
retrieval API documentation.

Updates HashiCorp Vault documentation to explicitly mention this
feature is supported and used by HashiCorp Vault.

Closes #2787

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Improves documentation, kas k8s as a multi kv secret store.

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Removing TODO and small fix

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Minor fix

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Clarification about vaultValueType

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Improve Local File Secret Store documentation

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Tiny fixes

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Tiny fixes

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Apply suggestions from code review

Applying suggestions from @greenie-msft

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Apply suggestions from code review

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Apply suggestions from code review

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Apply suggestions from code review

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Update daprdocs/content/en/reference/components-reference/supported-secret-stores/file-secret-store.md

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Apply suggestions from code review

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

* Update `multiValued` definition

Makes its relation to the `multipleKeyValuesPerSecret` behavior explicit.

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>
Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
 		2022-10-11 16:34:02 -07:00
.github Upmerge v1.8 --> v1.9 - 9/28 (#2839) 2022-09-28 15:51:02 -07:00
daprdocs Update SecretStore API documentation to account for Features feature. (#2863) 2022-10-11 16:34:02 -07:00
sdkdocs [Multi-tenancy/namespace consumer group] Create howto and add to overview (#2864) 2022-10-07 09:37:16 -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 Upmerge v1.8 --> v1.9 - 9/28 (#2839) 2022-09-28 15:51:02 -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.8 (primary) https://docs.dapr.io Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
v1.9 (pre-release) https://v1-9.docs.dapr.io/ Pre-release documentation. Doc updates that are only applicable to v1.9+ 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.