New version script generator

_includes/docker-compose-upgrade-instructions.md

@@ -0,0 +1,95 @@
+{%- assign platform = "ThingsBoard CE" -%}
+{%- assign current_version = include.version -%}
+{%- assign current_version_with_platform = current_version -%}
+{%- assign previous_version = include.prev_version -%}
+{%- assign update_status = include.update_status | default: "true" -%}
+{%- assign applicable_versions = include.applicable_versions -%}
+{%- assign x_status = include.x -%}
+
+{% if docsPrefix == "pe/" %}
+{%- assign platform = "ThingsBoard PE" -%}
+{%- assign current_version_with_platform = current_version | append: "pe" -%}
+{% endif %}
+
+{%- assign curr_parts = current_version | split: "." -%}
+{%- assign prev_parts = previous_version | split: "." -%}
+
+{%- assign curr_major = curr_parts[0] -%}
+{%- assign curr_minor = curr_parts[1] -%}
+
+{%- assign prev_major = prev_parts[0] -%}
+{%- assign prev_minor = prev_parts[1] -%}
+
+{%- assign previous_version_anchor = previous_version | replace: ".", "" -%}
+
+{%- assign previous_version_path = prev_major | append: "-" | append: prev_minor | append: "-x" -%}
+
+{%- assign use_external_link = false -%}
+{%- if curr_major != prev_major or curr_minor != prev_minor -%}
+{%- assign use_external_link = true -%}
+{%- endif -%}
+
+{%- assign prev_parts = previous_version | split: "." -%}
+{%- assign prev_major = prev_parts[0] -%}
+{%- assign prev_minor = prev_parts[1] -%}
+
+### Upgrading {{ platform }} to {{ current_version }}
+
+{%- if x_status == "true" -%}
+{%- assign prev_version_label = prev_major | append: "." | append: prev_minor | append: ".x" -%}
+{%- else -%}
+{%- assign prev_version_label = previous_version -%}
+{%- endif -%}
+
+{% if docsPrefix == "pe/" %}
+{%- assign prev_version_label = prev_version_label | append: "PE" -%}
+{% endif %}
+
+{% assign platform_hash = "#upgrading-thingsboard-ce-to-" %}
+{% if docsPrefix == "pe/" %}
+{%- assign platform_hash = "#upgrading-thingsboard-pe-to-" -%}
+{% endif %}
+
+{%- if use_external_link -%}
+{%- assign prev_version_href = "/docs/" | append: docsPrefix | append: "user-guide/install/upgrade-instructions/docker-compose/v" | append: previous_version_path | append: "/" | append: platform_hash | append: previous_version_anchor -%}
+{%- else -%}
+{%- assign prev_version_href = platform_hash | append: previous_version_anchor -%}
+{%- endif -%}
+
+{% capture difference %}
+**NOTE:**
+<br>
+These upgrade steps are applicable for ThingsBoard version {{ prev_version_label }}{% if applicable_versions %}{% assign versions = applicable_versions | split: "," %}{% for v in versions %} and ThingsBoard version {{ v | strip }}{% endfor %}{% endif %}.
+In order to upgrade to {{ current_version_with_platform | upcase }} you need to [**upgrade to {{ prev_version_label }} first**]({{ prev_version_href }}).
+{% endcapture %}
+{% include templates/info-banner.md content=difference %}
+
+{% assign docker-compose-repo-link = "https://github.com/thingsboard/" %}
+
+{% if docsPrefix == "pe/" %}
+{% assign docker-compose-repo-link = docker-compose-repo-link | append: "thingsboard-pe-docker-compose/tree/release-" | append: current_version %}
+{% else %}
+{% assign docker-compose-repo-link = docker-compose-repo-link | append: "thingsboard/tree/v" | append: current_version | append: "/docker" %}
+{% endif %}
+
+{% capture update_manifests_note %}
+We strongly recommend that you also update your Docker Compose deployment manifests to [**the corresponding version from GitHub repository**]({{ docker-compose-repo-link }}) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
+<br>
+<br>
+If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
+{% endcapture %}
+{% include templates/warn-banner.md content=update_manifests_note %}
+
+#### {{ platform }} service upgrade
+
+{% assign skipUpgrade = false %}
+{% if update_status == "false" %}
+{% assign skipUpgrade = true %}
+{% endif %}
+
+{% assign version = version %}
+{% if docsPrefix == "pe/" %}
+{% assign version = version | append: "PE" %}
+{% endif %}
+
+{% include docs/user-guide/install/docker-compose-upgrade-steps.md version=version skipUpgrade=skipUpgrade %}

_includes/docker-upgrade-instructions.md

@@ -0,0 +1,79 @@
+{%- assign platform = "ThingsBoard CE" -%}
+{%- assign current_version = include.version -%}
+{%- assign current_version_with_platform = current_version -%}
+{%- assign previous_version = include.prev_version -%}
+{%- assign update_status = include.update_status | default: "true" -%}
+{%- assign applicable_versions = include.applicable_versions -%}
+{%- assign x_status = include.x -%}
+
+{% if docsPrefix == "pe/" %}
+{%- assign platform = "ThingsBoard PE" -%}
+{%- assign current_version_with_platform = current_version | append: "pe" -%}
+{% endif %}
+
+{%- assign curr_parts = current_version | split: "." -%}
+{%- assign prev_parts = previous_version | split: "." -%}
+
+{%- assign curr_major = curr_parts[0] -%}
+{%- assign curr_minor = curr_parts[1] -%}
+
+{%- assign prev_major = prev_parts[0] -%}
+{%- assign prev_minor = prev_parts[1] -%}
+
+{%- assign previous_version_anchor = previous_version | replace: ".", "" -%}
+
+{%- assign previous_version_path = prev_major | append: "-" | append: prev_minor | append: "-x" -%}
+
+{%- assign use_external_link = false -%}
+{%- if curr_major != prev_major or curr_minor != prev_minor -%}
+{%- assign use_external_link = true -%}
+{%- endif -%}
+
+{%- assign prev_parts = previous_version | split: "." -%}
+{%- assign prev_major = prev_parts[0] -%}
+{%- assign prev_minor = prev_parts[1] -%}
+
+### Upgrading {{ platform }} to {{ current_version }}
+
+{%- if x_status == "true" -%}
+{%- assign prev_version_label = prev_major | append: "." | append: prev_minor | append: ".x" -%}
+{%- else -%}
+{%- assign prev_version_label = previous_version -%}
+{%- endif -%}
+
+{% if docsPrefix == "pe/" %}
+{%- assign prev_version_label = prev_version_label | append: "PE" -%}
+{% endif %}
+
+{% assign platform_hash = "#upgrading-thingsboard-ce-to-" %}
+{% if docsPrefix == "pe/" %}
+{%- assign platform_hash = "#upgrading-thingsboard-pe-to-" -%}
+{% endif %}
+
+{%- if use_external_link -%}
+{%- assign prev_version_href = "/docs/" | append: docsPrefix | append: "user-guide/install/upgrade-instructions/docker/v" | append: previous_version_path | append: "/" | append: platform_hash | append: previous_version_anchor -%}
+{%- else -%}
+{%- assign prev_version_href = platform_hash | append: previous_version_anchor -%}
+{%- endif -%}
+
+{% capture difference %}
+**NOTE:**
+<br>
+These upgrade steps are applicable for ThingsBoard version {{ prev_version_label }}{% if applicable_versions %}{% assign versions = applicable_versions | split: "," %}{% for v in versions %} and ThingsBoard version {{ v | strip }}{% endfor %}{% endif %}.
+In order to upgrade to {{ current_version_with_platform | upcase }} you need to [**upgrade to {{ prev_version_label }} first**]({{ prev_version_href }}).
+{% endcapture %}
+{% include templates/info-banner.md content=difference %}
+
+#### {{ platform }} service upgrade
+
+{% assign skipUpgrade = false %}
+{% if update_status == "false" %}
+{% assign skipUpgrade = true %}
+{% endif %}
+
+{% if docsPrefix == "pe/" %}
+{% assign pe_version = version | append: "PE" %}
+{% include docs/pe/user-guide/install/docker-upgrade-steps.md version=pe_version skipUpgrade=skipUpgrade %}
+{% else %}
+{% include docs/user-guide/install/docker-upgrade-steps.md version=version skipUpgrade=skipUpgrade %}
+{% endif %}

_includes/releases-table.liquid

@@ -23,6 +23,7 @@
         </div>
 
         <div class="releases-table-row">
+            {% assign active_lts_already_set = false %}
             {% for page in releases %}
                 {% if page.name != "index.md" %}
                     {% assign version = page.name | split: "." | first %}
@@ -60,14 +61,21 @@
 
 
                             {% if page.lts %}
+                                {% if active_lts_already_set == false %}
+                                    {% assign lts_label = "Active LTS" %}
+                                    {% assign active_lts_already_set = true %}
+                                {% else %}
+                                    {% assign lts_label = "Maintenance LTS" %}
+                                {% endif %}
+
                                 <a href="/docs/{{ docsPrefix }}releases/release-policy/"
-                                   class="releases-table-content-item version-link version-link-lts"
-                                   target="_blank">
-                                <span style="font-weight: 500; color: {% if docsPrefix == "pe/" %}#1F8B4D{% elsif docsPrefix == "edge/" %}#2260A7{% elsif docsPrefix == "pe/edge/" %}#009688{% else %}#2a7dec{% endif %}">
-                                    Active LTS
-                                </span>
+                                   class="releases-table-content-item version-link version-link-lts">
+                                    <span style="font-weight: 500; color: {% if docsPrefix == "pe/" %}#1F8B4D{% elsif docsPrefix == "edge/" %}#2260A7{% elsif docsPrefix == "pe/edge/" %}#009688{% else %}#2a7dec{% endif %}">
+                                        {{ lts_label }}
+                                    </span>
                                     <i class="fas fa-external-link-alt"
-                                       style="color: {% if docsPrefix == "pe/" %}#1F8B4D{% elsif docsPrefix == "edge/" %}#2260A7{% elsif docsPrefix == "pe/edge/" %}#009688{% else %}#2a7dec{% endif %}"></i>
+                                       style="color: {% if docsPrefix == "pe/" %}#1F8B4D{% elsif docsPrefix == "edge/" %}#2260A7{% elsif docsPrefix == "pe/edge/" %}#009688{% else %}#2a7dec{% endif %}">
+                                    </i>
                                 </a>
                             {% else %}
                                 <div class="releases-table-content-item">Standard</div>
@@ -124,9 +132,10 @@
         </div>
     </div>
 </div>
-<ul class="legend{% if docsPrefix == "pe/" %} pe{% elsif docsPrefix == "edge/" or docsPrefix == "pe/edge/" %} edge{% endif %}">
-    <li class="list-link"><a href="/docs/{{ docsPrefix }}releases/release-policy/" target="_blank">Active LTS</a> - releases are supported for 18 months from the initial release date.</li>
-    <li>Standard - releases are supported for six months from the initial release date.</li>
+<ul class="legend{% if docsPrefix == "pe/" %} pe{% elsif docsPrefix == "edge/" %} edge{% elsif docsPrefix == "pe/edge/" %} pe-edge{% endif %}">
+    <li class="list-link"><a href="/docs/{{ docsPrefix }}releases/release-policy/">Active LTS</a> - releases supported for 18 months from initial release date</li>
+    <li class="list-link"><a href="/docs/{{ docsPrefix }}releases/release-policy/">Maintenance LTS</a> - older LTS releases still supported within the LTS window</li>
+    <li>Standard - releases supported for 6 months from initial release date</li>
 </ul>
 <div class="fixed-upgrade-scrollbar" id="fixedScrollbar">
     <div class="scrollbar-inner"></div>

_includes/releases-table.sass

@@ -18,7 +18,7 @@
       &:nth-child(3)
         min-width: 175px
       &:nth-child(4)
-        min-width: 135px
+        min-width: 150px
       &:nth-child(5)
         min-width: 180px
       &:nth-child(6)

_includes/upgrade-instructions.liquid

@@ -41,6 +41,10 @@
 {% include ubuntu-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions manual_version_upgrade=data.manual-version-upgrade manual_version_upgrade_label=data.manual-version-upgrade-label %}
 {% elsif os == "centos" %}
 {% include centos-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions manual_version_upgrade=data.manual-version-upgrade manual_version_upgrade_label=data.manual-version-upgrade-label %}
+{% elsif os == "docker" %}
+{% include docker-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions %}
+{% elsif os == "docker-compose" %}
+{% include docker-compose-upgrade-instructions.md version=display_version prev_version=display_prev_version x=data.x update_status=data.upgrade applicable_versions=applicable_versions %}
 {% endif %}
 {% endif %}
 

docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x.md

@@ -12,68 +12,6 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/'
 * TOC
 {:toc}
 
-### Upgrading ThingsBoard PE to 4.0.2
+{% assign docsPrefix = "pe/" %}
 
-{% capture difference %}
-**NOTE:**
-<br>
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.2PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391).
-<br>
-{% endcapture %}
-{% include templates/info-banner.md content=difference %}
-
-{% capture update_manifests_note %}
-We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
-<br>
-<br>
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
-{% endcapture %}
-{% include templates/warn-banner.md content=update_manifests_note %}
-
-#### ThingsBoard PE service upgrade
-
-{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.2PE" %}
-
-### Upgrading ThingsBoard PE to 4.0.1
-
-{% capture difference %}
-**NOTE:**
-<br>
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE and ThingsBoard version 4.0.xPE. In order to upgrade to 4.0.1PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391).
-<br>
-{% endcapture %}
-{% include templates/info-banner.md content=difference %}
-
-{% capture update_manifests_note %}
-We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
-<br>
-<br>
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
-{% endcapture %}
-{% include templates/warn-banner.md content=update_manifests_note %}
-
-#### ThingsBoard PE service upgrade
-
-{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.1PE" %}
-
-### Upgrading ThingsBoard PE to 4.0.0
-
-{% capture difference %}
-**NOTE:**
-<br>
-These upgrade steps are applicable for ThingsBoard version 3.9.xPE. In order to upgrade to 4.0PE you need to [**upgrade to 3.9.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/#upgrading-thingsboard-pe-to-391).
-<br>
-{% endcapture %}
-{% include templates/info-banner.md content=difference %}
-
-{% capture update_manifests_note %}
-We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
-<br>
-<br>
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
-{% endcapture %}
-{% include templates/warn-banner.md content=update_manifests_note %}
-
-#### ThingsBoard PE service upgrade
-
-{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.0.0PE" %}
+{% include upgrade-instructions.liquid family="4.0" os="docker-compose" %}

docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x.md

@@ -12,24 +12,7 @@ effective-url: '/docs/pe/user-guide/install/upgrade-instructions/'
 * TOC
 {:toc}
 
-### Upgrading ThingsBoard PE to 4.1.0
+{% assign docsPrefix = "pe/" %}
 
-{% capture difference %}
-**NOTE:**
-<br>
-These upgrade steps are applicable for ThingsBoard version 4.0.xPE. In order to upgrade to 4.1PE you need to [**upgrade to 4.0.2PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/#upgrading-thingsboard-pe-to-402).
-<br>
-{% endcapture %}
-{% include templates/info-banner.md content=difference %}
+{% include upgrade-instructions.liquid family="4.1" os="docker-compose" %}
 
-{% capture update_manifests_note %}
-We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
-<br>
-<br>
-If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
-{% endcapture %}
-{% include templates/warn-banner.md content=update_manifests_note %}
-
-#### ThingsBoard PE service upgrade
-
-{% include docs/user-guide/install/docker-compose-upgrade-steps.md version="4.1.0PE" %}