From deaf33a288953c06b2995b957590a5c7612b4d6e Mon Sep 17 00:00:00 2001 From: Maggie Neterval Date: Tue, 21 Apr 2020 10:34:34 -0400 Subject: [PATCH] feat(docs): document how to hide stages from end-users (#1807) * feat(docs): document how to hide stages from end-users * fix(docs): address dorbin@ code review comments Co-authored-by: Dave Dorbin --- _data/navigation.yml | 2 ++ guides/operator/hiding-stages.md | 16 ++++++++++++++++ setup/ci/travis.md | 2 +- setup/ci/wercker.md | 2 +- 4 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 guides/operator/hiding-stages.md diff --git a/_data/navigation.yml b/_data/navigation.yml index 526c1b0fd7..b0aee8084c 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -501,6 +501,8 @@ guides: url: /guides/operator/webhook-custom-trust-store/ - title: "Orca: Redis to SQL" url: /guides/operator/orca-redis-to-sql/ + - title: Hiding Stages + url: /guides/operator/hiding-stages/ - title: Runbooks collapsed: true children: diff --git a/guides/operator/hiding-stages.md b/guides/operator/hiding-stages.md new file mode 100644 index 0000000000..61e947c95a --- /dev/null +++ b/guides/operator/hiding-stages.md @@ -0,0 +1,16 @@ +--- +layout: single +title: "Hiding Stages" +sidebar: + nav: guides +--- + +If you're using Spinnaker 1.20 or later, stages that are not provider-specific will be +available by default. To hide specific stages from end-users, set the +`hiddenStages` property in Deck's [custom profile](/reference/halyard/custom/#custom-profile-for-deck) +to a list of the keys of stages you wish to hide. For example, to hide the +Gremlin and Travis stages, include the following in `settings-local.js`: + +```js + window.spinnakerSettings.hiddenStages = ['gremlin', 'travis']; +``` diff --git a/setup/ci/travis.md b/setup/ci/travis.md index 7e47ac74ee..9cea66f7fd 100644 --- a/setup/ci/travis.md +++ b/setup/ci/travis.md @@ -25,7 +25,7 @@ repos you should see. `hal config ci travis enable` -1. Turn on the Travis stage feature: +1. If you're using Spinnaker 1.19 or earlier, turn on the Travis stage feature: `hal config features edit --travis true` diff --git a/setup/ci/wercker.md b/setup/ci/wercker.md index 7fe23365ce..179190d835 100644 --- a/setup/ci/wercker.md +++ b/setup/ci/wercker.md @@ -28,7 +28,7 @@ and credentials. hal config ci wercker enable ``` -2. And that the Wercker stage feature flag is turned on: +2. If you're using Spinnaker 1.19 or earlier, make sure that the Wercker stage feature flag is turned on: ```bash hal config features edit --wercker true