diff options
| -rw-r--r-- | .gitlab/issue_templates/Survey banner request.md | 12 | ||||
| -rw-r--r-- | README.md | 22 |
2 files changed, 33 insertions, 1 deletions
diff --git a/.gitlab/issue_templates/Survey banner request.md b/.gitlab/issue_templates/Survey banner request.md new file mode 100644 index 00000000..68f8d9a2 --- /dev/null +++ b/.gitlab/issue_templates/Survey banner request.md @@ -0,0 +1,12 @@ +## Survey banner request + +Fill in the following information: + +- What is the survey about? Please add a link for any related issues: +- Survey text: `Your survey description here.` +- Survey link: +- Date to be published: +- Date to be unpublished: + +/label ~"Category:Docs Site" ~"survey banner" +/assign @axil @@ -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 |