From 59715747ad51e135a963ddf1fbb8f383bcb61407 Mon Sep 17 00:00:00 2001 From: Leif Battermann Date: Wed, 30 Nov 2022 15:58:47 +0000 Subject: [PATCH 1/2] Update PR guideline docs --- docs/src/developer/developer/pr-guidelines.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/src/developer/developer/pr-guidelines.md b/docs/src/developer/developer/pr-guidelines.md index 60acfaab6e..f925e1a0b0 100644 --- a/docs/src/developer/developer/pr-guidelines.md +++ b/docs/src/developer/developer/pr-guidelines.md @@ -44,10 +44,14 @@ The following needs to be done, as part of a PR adding endpoints or changing end ### Helm configuration For internal endpoints for QA access on staging environments, copy a block with `/i/` containing + ``` -zauth: false -basic_auth: true -whitelisted_envs: ['staging'] + - path: /some/path + envs: + - staging + disable_zauth: true + basic_auth: true + versioned: false ``` For customer support access to an internal endpoint, instead update code in [stern](https://github.com/wireapp/wire-server/tree/develop/tools/stern) as part of your PR. There is no need to add that endpoint to nginz. From 90895a4ead3cd1453da1a3494e56bdfa9d5a133c Mon Sep 17 00:00:00 2001 From: Leif Battermann Date: Wed, 30 Nov 2022 16:01:26 +0000 Subject: [PATCH 2/2] changelog --- changelog.d/4-docs/pr-2889 | 1 + docs/src/developer/developer/pr-guidelines.md | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 changelog.d/4-docs/pr-2889 diff --git a/changelog.d/4-docs/pr-2889 b/changelog.d/4-docs/pr-2889 new file mode 100644 index 0000000000..a4f811ceb8 --- /dev/null +++ b/changelog.d/4-docs/pr-2889 @@ -0,0 +1 @@ +PR guidelines docs are updated with correct helm configuration syntax diff --git a/docs/src/developer/developer/pr-guidelines.md b/docs/src/developer/developer/pr-guidelines.md index f925e1a0b0..ab30aef251 100644 --- a/docs/src/developer/developer/pr-guidelines.md +++ b/docs/src/developer/developer/pr-guidelines.md @@ -51,7 +51,6 @@ For internal endpoints for QA access on staging environments, copy a block with - staging disable_zauth: true basic_auth: true - versioned: false ``` For customer support access to an internal endpoint, instead update code in [stern](https://github.com/wireapp/wire-server/tree/develop/tools/stern) as part of your PR. There is no need to add that endpoint to nginz.