diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2021-08-25 12:18:43 +0300 |
|---|---|---|
| committer | David O'Regan <doregan@gitlab.com> | 2021-08-25 12:18:43 +0300 |
| commit | 7508e6196888aaef7711d25b96e8a43eb2c00a7f (patch) | |
| tree | 9b59d09fb37413f1a7be73940db12ac37aab0f4d /README.md | |
| parent | 82ffd7ac8b036b8ed7ce7a516c4b5717a061fa71 (diff) | |
Move survey banner into a YAML file
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 6 insertions, 10 deletions
@@ -508,18 +508,14 @@ In case there's a survey that needs to reach a big audience, the docs site has the ability to host a banner for that purpose. When it is enabled, it's shown at the top of every page of the docs site. -To publish a survey: +To publish a survey, edit [`banner.yaml`](/content/_data/banner.yaml) and: -1. Edit [`layouts/banner.html`](/layouts/banner.html) and fill in the required - information like the description text and the survey link. -1. Edit [`nanoc.yaml`](nanoc.yaml) and set `show_banner` to `true`. +1. Set `show_banner` to `true`. +1. Under `description`, add what information you want to appear in the banner. + Markdown is supported. -To unpublish a survey: - -1. Edit [`nanoc.yaml`](nanoc.yaml) and set `show_banner` to `false`. -1. Edit [`layouts/banner.html`](/layouts/banner.html) remove the survey link. - This step is optional, but it's good to have the link removed so that it's - not exposed when no new survey answers are needed. +To unpublish a survey, edit [`banner.yaml`](/content/_data/banner.yaml) and +set `show_banner` to `false`. ## CSP header |