diff options
Diffstat (limited to 'docs/docsite/.templates/banner.html')
-rw-r--r-- | docs/docsite/.templates/banner.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/docsite/.templates/banner.html b/docs/docsite/.templates/banner.html new file mode 100644 index 0000000..698870f --- /dev/null +++ b/docs/docsite/.templates/banner.html @@ -0,0 +1,77 @@ +{% if is_eol %} +{# Creates a banner at the top of the page for EOL versions. #} +<div id='banner' class='Admonition caution'> + <p>You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See <a href="/ansible/latest/">the latest Ansible documentation</a>.</p> +</div> +{% else %} + <script> + function startsWith(str, needle) { + return str.slice(0, needle.length) == needle + } + function startsWithOneOf(str, needles) { + return needles.some(function (needle) { + return startsWith(str, needle); + }); + } + var banner = ''; + var extra_banner = ''; + /*use extra_banner for when marketing wants something extra, like a survey or AnsibleFest notice */ + var extra_banner = + '<div id="latest_extra_banner_id" class="admonition important">' + + '<br>' + + '<p>' + + '<b>Experience AnsibleFest at Red Hat Summit</b>' + + '</p>' + + '<p>' + + 'We\'re bringing AnsibleFest to Red Hat Summit in Boston, May 23-25. It\'s the best of Fest combined with Red Hat Summit for even more learning and technical engagement. <a href="https://www.redhat.com/en/summit/ansiblefest?intcmp=7013a0000034lvhAAA">Learn more.</a> ' + + + '</p>' + + '<br>' + + '</div>'; + // Create a banner if we're not on the official docs site + if (location.host == "docs.testing.ansible.com") { + document.write('<div id="testing_banner_id" class="admonition important">' + + '<p>This is the testing site for Ansible Documentation. Unless you are reviewing pre-production changes, please visit the <a href="https://docs.ansible.com/ansible/latest/">official documentation website</a>.</p> <p></p>' + + '</div>'); + } + {% if available_versions is defined %} + // Create a banner + current_url_path = window.location.pathname; + + var important = false; + var msg = '<p>'; + if (startsWith(current_url_path, "/ansible-core/")) { + msg += 'You are reading documentation for Ansible Core, which contains no plugins except for those in ansible.builtin. For documentation of the Ansible package, go to <a href="/ansible/latest">the latest documentation</a>.'; + } else if (startsWithOneOf(current_url_path, ["/ansible/latest/", "/ansible/{{ latest_version }}/"])) { + /* temp extra banner to advertise AnsibeFest2021 */ + banner += extra_banner; + + msg += 'You are reading the <b>latest</b> (stable) community version of the Ansible documentation. If you are a Red Hat customer, refer to the <a href="https://access.redhat.com/support/policy/updates/ansible-automation-platform">Ansible Automation Platform Life Cycle</a> page for subscription details.'; + } else if (startsWith(current_url_path, "/ansible/2.9/")) { + msg += 'You are reading the latest Red Hat released version of the Ansible documentation. Community users can use this version, or select <b>latest</b> from the version selector to the left for the most recent community version.'; + } else if (startsWith(current_url_path, "/ansible/devel/")) { + /* temp extra banner to advertise AnsibleFest2021 */ + banner += extra_banner; + + /* temp banner to advertise survey + important = true; + msg += 'Please take our <a href="https://www.surveymonkey.co.uk/r/B9V3CDY">Docs survey</a> before December 31 to help us improve Ansible documentation.'; + */ + + msg += 'You are reading the <b>devel</b> version of the Ansible documentation - this version is not guaranteed stable. Use the version selection to the left if you want the <b>latest</b> (stable) released version.'; + } else { + msg += 'You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the <b>latest</b> (stable) released version.'; + } + msg += '</p>'; + + banner += '<div id="banner_id" class="admonition '; + banner += important ? 'important' : 'caution'; + banner += '">'; + banner += important ? '<br>' : ''; + banner += msg; + banner += important ? '<br>' : ''; + banner += '</div>'; + document.write(banner); + {% endif %} + </script> +{% endif %} |