PXC-4344 PXC 5.7.44-31.65 release notes and release note tasks (5.7) (#…

…129) * PXC-4344 PXC 5.7.44-31.65 release notes and release note tasks (5.7) new file: docs/release-notes/5.7.44-31.65.md modified: docs/release-notes/release-notes_index.md new file: docs/telemetry.md modified: mkdocs-base.yml modified: variables.yml * fix pdf generation modified: _resource/overrides/main.html deleted: _resource/overrides/partials/nav.html modified: mkdocs-base.yml modified: mkdocs.yml --------- Co-authored-by: Alina Derkach <[email protected]>
percona · Dec 26, 2023 · ba4837c · ba4837c
1 parent a9c2e32
commit ba4837c
Show file tree

Hide file tree

Showing 8 changed files with 132 additions and 102 deletions.
diff --git a/_resource/overrides/main.html b/_resource/overrides/main.html
@@ -35,65 +35,36 @@ <h3>Contact us </h3>
               <meta property="og:url" content="https://docs.percona.com/percona-xtradb-cluster/5.7/">
               {% endblock %}
 
-              {% block analytics %}
-              <!-- Google Tag Manager -->
-              <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
-              new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
-              j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-              'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-              })(window,document,'script','dataLayer','GTM-WBVF48V');</script>
-              <!-- End Google Tag Manager -->
-
-              <!-- Google Tag Manager (noscript) -->
-              <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WBVF48V"
-              height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
-              <!-- End Google Tag Manager (noscript) -->
-              {% endblock %}
-
-              {% block content %}
-
-                <!-- Edit and view button -->
-                {% if page.edit_url %}
-                  {% set edit = "https://github.com/percona/pxc-docs/edit/5.7/docs/" %}
-                  {% set view = "https://raw.githubusercontent.com/percona/pxc-docs/5.7/docs/" %}
-                  <a
-                    href="{{ page.edit_url }}"
-                    title="{{ lang.t('edit.link.title') }}"
-                    class="md-content__button md-icon"
-                  >
-                    {% include ".icons/material/file-edit-outline.svg" %}
-                  </a>
-                  <a
-                    href="{{ page.edit_url | replace(edit, view) }}"
-                    title="View source of this page"
-                    class="md-content__button md-icon"
-                  >
-                    {% include ".icons/material/file-eye-outline.svg" %}
-                  </a>
+              {% block site_nav %}
+              {% if nav %}
+                {% if page.meta and page.meta.hide %}
+                  {% set hidden = "hidden" if "navigation" in page.meta.hide %}
                 {% endif %}
-
-                <!--
-                  Hack: check whether the content contains a h1 headline. If it
-                  doesn't, the page title (or respectively site name) is used
-                  as the main headline.
-                -->
-                {% if "\x3ch1" not in page.content %}
-                  <h1>{{ page.title | d(config.site_name, true)}}</h1>
-                {% endif %}
-
-                <!-- Markdown content -->
-                {{ page.content }}
-
-                {{ relbar2() }}
-
-                <!-- Last update of source file -->
-                {% if page and page.meta %}
-                  {% if page.meta.git_revision_date_localized or
-                        page.meta.revision_date
-                  %}
-                    {% include "partials/source-file.html" %}
-                  {% endif %}
+                <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" {{ hidden }}>
+                  <div class="md-sidebar__scrollwrap">
+                    <div class="md-sidebar__inner">
+                      {% include "partials/nav.html" %}
+                      <br>
+                      <label class="md-nav__title" for="__drawer">
+                 <a href="https://learn.percona.com/download-percona-xtradb-cluster-5-7-manual" onclick="_gaq.push(['b._trackEvent', 'Percona XtraDB Cluster', 'Download', 'Download Manual Percona XtraDB Cluster']);" class="md-nav__link md-nav__link--active">
+                   Download PDF
+                 </a>
+    </label> 
+                    </div>
+                  </div>
+                </div>
+              {% endif %}
+              {% if "toc.integrate" not in features %}
+                {% if page.meta and page.meta.hide %}
+                  {% set hidden = "hidden" if "toc" in page.meta.hide %}
                 {% endif %}
-              {% endblock %}
-
+                <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" {{ hidden }}>
+                  <div class="md-sidebar__scrollwrap">
+                    <div class="md-sidebar__inner">
+                      {% include "partials/toc.html" %}
+                    </div>
+                  </div>
+                </div>
+              {% endif %}
+            {% endblock %}
 
diff --git a/_resource/overrides/partials/nav.html b/_resource/overrides/partials/nav.html
diff --git a/docs/release-notes/5.7.44-31.65.md b/docs/release-notes/5.7.44-31.65.md
@@ -0,0 +1,35 @@
+# Percona XtraDB Cluster 5.7.44-31.65 (2023-12-26)
+
+!!! important
+
+    Percona XtraDB Cluster 5.7.44-31.65 is the final release of the Percona XtraDB Cluster 5.7 series.
+
+    Do you need help upgrading to MySQL 8.0? Do you need to stay on MySQL 5.7 a bit longer? [We will support you either way].
+
+Percona XtraDB Cluster (PXC) supports critical business applications in your public, private, or hybrid cloud environment.
+
+## Release highlights
+
+Percona XtraDB Cluster implements telemetry that fills the gaps in our understanding of how you use XtraDB Cluster to improve our products. Participation in the anonymous program is optional. You can opt-out if you prefer not to share this information. Find more details in the [Telemetry on Percona XtraDB Cluster](../telemetry.md) document.
+
+Improvements and bug fixes provided by Oracle for MySQL 5.7.44 and included in the Percona XtraDB Cluster are the following:
+
+* Upgraded the linked Open SSL library to OpenSSL 3.0.10
+
+* Removed the printed query string limit to display the characters for a detected deadlock section of the engine status log
+
+Find the complete list of additions or bug fixes in the [MySQL 5.7.44 Release Notes](https://dev.mysql.com/doc/relnotes/mysql/5.7/en/news-5-7-44.html).
+
+## Useful links
+
+[Install Percona XtraDB Cluster](https://www.percona.com/doc/percona-xtradb-cluster/5.7/install/index.html)
+
+[Percona Product downloads](https://www.percona.com/downloads)
+
+The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtradb-cluster)
+
+[Contribute to the documentation](https://github.com/percona/pxc-docs/blob/8.0/contributing.md)
+
+For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me)
+
+[We will support you either way]: https://www.percona.com/navigating-mysql-5-7-end-of-life
diff --git a/docs/release-notes/release-notes_index.md b/docs/release-notes/release-notes_index.md
@@ -1,5 +1,7 @@
 # Percona XtraDB Cluster 5.7 Release notes index
 
+* [Percona XtraDB Cluster 5.7.44-31.65 (2023-12-26)](5.7.44-31.65.md)
+
 * [Percona XtraDB Cluster 5.7.43-31.65 (2023-08-31)](5.7.43-31.65.md)
 
 * [Percona XtraDB Cluster 5.7.42-31.65 (2023-06-08)](5.7.42-31.65.md)

diff --git a/docs/telemetry.md b/docs/telemetry.md
@@ -0,0 +1,53 @@
+# Telemetry on Percona XtraDB Cluster
+
+Percona telemetry fills in the gaps in our understanding of how you use the Percona XtraDB Cluster to improve our products. Participation in the anonymous program is optional. You can opt out if you prefer to not share this information.
+
+## What information is collected
+
+At this time, telemetry is added only to the Percona packages and Docker images. Percona XtraDB Cluster collects only information about the installation environment. Future releases may add additional metrics.
+
+Be assured that access to this raw data is rigorously controlled. Percona does not collect personal data. All data is anonymous and cannot be traced to a specific user. To learn more about our privacy practices, read our [Percona Privacy statement].
+
+An example of the data collected is the following:
+
+```JSON
+[{"id" : "c416c3ee-48cd-471c-9733-37c2886f8231",
+"product_family" : "PRODUCT_FAMILY_PXC",
+"instanceId" : "6aef422e-56a7-4530-af9d-94cc02198343",
+"createTime" : "2023-10-16T10:46:23Z",
+"metrics":
+[{"key" : "deployment","value" : "PACKAGE"},
+{"key" : "pillar_version","value" : "5.7.44-31.65"},
+{"key" : "OS","value" : "Oracle Linux Server 8.8"},
+{"key" : "hardware_arch","value" : "x86_64 x86_64"}]}]
+```
+
+## Disable telemetry
+
+Starting with Percona XtraDB Cluster 5.7.44-31.65, telemetry is enabled by default. If you decide not to send usage data to Percona, you can set the `PERCONA_TELEMETRY_DISABLE=1` environment variable for either the root user or the operating system before the installation process.
+
+=== "Debian-derived distribution"
+
+    Add the environment variable before the installation process.
+
+    ```{.bash data-prompt="$"}
+    $ sudo PERCONA_TELEMETRY_DISABLE=1 apt install percona-xtradb-cluster
+    ```
+
+=== "Red Hat-derived distribution"
+
+    Add the environment variable before the install process.
+
+    ```{.bash data-prompt="$"}
+    $ sudo PERCONA_TELEMETRY_DISABLE=1 yum install percona-xtradb-cluster
+    ```
+
+=== "DOCKER"
+
+    Add the environment variable when running a command in a new container.
+
+    ```{.bash data-prompt="$"}
+    $ docker run -d -e MYSQL_ROOT_PASSWORD=test1234# -e PERCONA_TELEMETRY_DISABLE=1 -e CLUSTER_NAME=pxc-cluster1 --name=pxc-node1 percona/percona-xtradb-cluster:5.7
+    ```
+
+[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -50,6 +50,10 @@ extra_css:
   - css/nocopy.css\
   - css/extra.css
 
+#Copyright
+copyright: >
+  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2023 — <a href="#__consent">Cookie Consent</a>
+
 extra_javascript:
   - js/version-select.js
   - js/promptremover.js
@@ -101,7 +105,7 @@ plugins:
   with-pdf: # https://github.com/orzih/mkdocs-with-pdf
           output_path: '_pdf/PerconaXtradbCluster-5.7.pdf'
           cover_title: 'Percona XtraDB Cluster Documentation'
-          cover_subtitle: 5.7.43-31.66 (2023-08-31)
+          cover_subtitle: 5.7.44-31.65 (2023-12-26)
           author: 'Percona Technical Documentation Team'
           cover_logo: docs/_static/Percona_Logo_Color.png
           debug_html: false
@@ -125,11 +129,14 @@ extra:
       as to measure the effectiveness of our documentation and whether users
       find what they're searching for. With your consent, you're helping us to
       make our documentation better. Read more about <a class="reference external" href="https://www.percona.com/20180524-cookie-policy" target="_blank">Percona Cookie Policy</a>.
+  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
+  updated_text: '<i class="uil uil-refresh"></i> Page updated'
 
 nav:
   - Home: index.md
   - Release notes:
       - release-notes/release-notes_index.md
+      - release-notes/5.7.44-31.65.md
       - release-notes/5.7.43-31.65.md
       - release-notes/5.7.42-31.65.md
       - release-notes/5.7.41-31.65.md
@@ -171,6 +178,7 @@ nav:
       - intro.md
       - limitation.md
       - xtradb-cluster-version-numbers.md
+      - telemetry.md
   - Getting Started:
       - overview.md
       - install/index.md

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,4 +13,4 @@ theme:
 extra:
   analytics:
     provider: google
-    property: UA-343802-3
+    property: G-J4J70BNH0G
diff --git a/variables.yml b/variables.yml
@@ -1,5 +1,5 @@
 # variables for HTML output
 
-release: '5.7.43-31.65'
+release: '5.7.44-31.65'
 version: '5.7'
-release-date: 2023
+release-date: 2023-12-26