diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2020-11-18 17:05:28 +0300 |
|---|---|---|
| committer | Susan Tacker <stacker@gitlab.com> | 2020-11-18 17:05:28 +0300 |
| commit | b7e5e5b2767cc5c93c483dd7c66aaae329226c64 (patch) | |
| tree | 75f6454a6f6a446fac83db4568e3141062d0e009 /README.md | |
| parent | 476980d0c2ef6c6dd9e1d9e09fe23f4756d96b56 (diff) | |
Add a survey banner issue template
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 21 insertions, 1 deletions
@@ -487,6 +487,26 @@ title "Email, Slack, and GitLab Groups and Aliases", search for `docsearch`, and add a comment with your email to be added to the alias that gets the weekly reports. +## Survey banner + +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: + +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`. + +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. + + ## CSP header The GitLab docs site uses a [Content Security Policy (CSP) header](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) @@ -539,4 +559,4 @@ it with: ### Testing the CSP header for conformity To test that the CSP header works as expected, you can visit -<https://cspvalidator.org/> and paste the URL that you want tested. +<https://cspvalidator.org/> and paste the URL that you want tested.
\ No newline at end of file |