Skip to content

Adds survey banner to the docs site #20444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

cgranleese-r7
Copy link
Contributor

This PR adds a user engagement survey banner. The banner will link the user to the survey. The banner can also be closed and remain closed if the user decides to do so. I have added some logic to push the site content down when the banner is present and then reverts to the original once the banner is closed.

Banner present

image

Banner closed

image

Verification

image

@@ -1,2 +1,11 @@
<link rel="stylesheet" href="{% link assets/css/main.css %}">

<!-- User Engagement Survey Banner -->
<div id="survey-banner">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker, the header shouldn't contain visual elements:

The element is a container for metadata (data about data) and is placed between the tag and the tag.
Metadata is data about the HTML document. Metadata is not displayed.
Metadata typically define the document title, character set, styles, scripts, and other meta information.
https://www.w3schools.com/tags/tag_head.asp

The tag defines the document's body.
The element contains all the contents of an HTML document, such as headings, paragraphs, images, hyperlinks, tables, lists, etc.
https://www.w3schools.com/tags/tag_body.asp

I wonder if there's an alterantive place to add this so it honors HTML semantics

@cgranleese-r7 cgranleese-r7 force-pushed the adds-survey-banner-docs-site branch from 2ecfd6a to 904acff Compare August 4, 2025 11:05
@adfoster-r7 adfoster-r7 added the rn-no-release-notes no release notes label Aug 4, 2025
@cgranleese-r7 cgranleese-r7 force-pushed the adds-survey-banner-docs-site branch from 904acff to 5fe57c6 Compare August 4, 2025 11:19
@adfoster-r7 adfoster-r7 marked this pull request as ready for review August 4, 2025 11:19
@adfoster-r7 adfoster-r7 merged commit f7930a9 into rapid7:master Aug 4, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn-no-release-notes no release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants