InfluxDB 1.8 backup/restore revamp (#4095)

* WIP 1.x backup/restore revamp * WIP backup and restore revamp * WIP backup restore refactor * WIP backup and restore rework * added code-callout shortcode * finished out backup/restore restructure
2022-06-08 17:02:19 -06:00 · 2022-06-08 17:02:19 -06:00 · 85fdbc439f
parent 0f3ef0d9ca
commit 85fdbc439f
18 changed files with 687 additions and 379 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -1114,6 +1114,19 @@ Use the `{{< caps >}}` shortcode to format text to match those buttons.
 Click {{< caps >}}Add Data{{< /caps >}}
 ```

+#### Code callouts
+Use the `{{< code-callout >}}` shortcode to highlight and emphasize a specific
+piece of code in a code block. Provide the string to highlight in the code block.
+Include a syntax for the codeblock to properly style the called out code.
+
+~~~md
+{{< code-callout "03a2bbf46249a000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}
+~~~
+
 #### InfluxDB University banners
 Use the `{{< influxdbu >}}` shortcode to add an InfluxDB University banner that
 points to the InfluxDB University site or a specific course.
--- a/assets/styles/layouts/article/_code.scss
+++ b/assets/styles/layouts/article/_code.scss
@ -64,9 +64,9 @@ pre {
  border-radius: $radius;
  overflow-x: scroll;
  overflow-y: hidden;
+  font-size: 1rem;
  code {
    padding: 0;
-    font-size: 1rem;
    line-height: 1.7rem;
    white-space: pre;
  }
--- a/assets/styles/layouts/article/_html-diagrams.scss
+++ b/assets/styles/layouts/article/_html-diagrams.scss
@ -15,7 +15,8 @@

      li {
        position: relative;
-        margin: 0;
+        margin: 0 0 0 -1.45rem;
+        padding-left: 1.45rem;
        line-height: 2.5rem;
        border-left: 1px solid $article-code;
        &:before {
@ -24,6 +25,7 @@
          width: 1rem;
          height: .25rem;
          margin-right: .55rem;
+          margin-left: -1.45rem;
          border-top: 1px solid $article-code;
        }
        &:last-child {
--- a/assets/styles/layouts/article/_lists.scss
+++ b/assets/styles/layouts/article/_lists.scss
@ -3,6 +3,8 @@
 ol, ul {
  padding-left: 1.6rem;
  margin: 1rem 0 1.5rem 0;
+
+  ol, ul {margin: 0;}
 }

 ul {
--- a/content/enterprise_influxdb/v1.9/administration/backup-and-restore.md
+++ b/content/enterprise_influxdb/v1.9/administration/backup-and-restore.md
@ -27,10 +27,12 @@ Depending on the volume of data to be protected and your application requirement
 - [Backup and restore utilities](#backup-and-restore-utilities) — For most applications
 - [Exporting and importing data](#exporting-and-importing-data) — For large datasets

-> **Note:** Use the [`backup` and `restore` utilities (InfluxDB OSS 1.5 and later)](/enterprise_influxdb/v1.9/administration/backup-and-restore/) to:
->
-> - Restore InfluxDB Enterprise backup files to InfluxDB OSS instances.
-> - Back up InfluxDB OSS data that can be restored in InfluxDB Enterprise clusters.
+{{% note %}}
+Use the [`backup` and `restore` utilities (InfluxDB OSS 1.5 and later)](/enterprise_influxdb/v1.9/administration/backup-and-restore/) to:
+
+- Restore InfluxDB Enterprise backup files to InfluxDB OSS instances.
+- Back up InfluxDB OSS data that can be restored in InfluxDB Enterprise clusters.
+{{% /note %}}

 ## Backup and restore utilities

@ -40,7 +42,7 @@ Most InfluxDB Enterprise applications can use the backup and restore utilities.

 Use the `backup` and `restore` utilities to back up and restore between `influxd`
 instances with the same versions or with only minor version differences.
-For example, you can backup from {{< latest-patch version="1.8" >}} and restore on {{< latest-patch >}}.
+For example, you can backup from {{< latest-patch minorVersionOffset=-1 >}} and restore on {{< latest-patch >}}.

 ### Backup utility

--- a/content/influxdb/cloud/organizations/view-orgs.md
+++ b/content/influxdb/cloud/organizations/view-orgs.md
@ -33,9 +33,11 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.

 After logging in to the InfluxDB UI, your organization ID appears in the URL.

-<pre class="highlight">
-https://cloud2.influxdata.com/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
-</pre>
+{{< code-callout "03a2bbf46249a000" >}}
+```sh
+https://cloud2.influxdata.com/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}

 ### Organization ID in the CLI

--- a/content/influxdb/cloud/reference/regions.md
+++ b/content/influxdb/cloud/reference/regions.md
@ -26,9 +26,12 @@ To find your cluster URL, [log in to your InfluxDB Cloud organization](https://c
 and review your organization URL. The first subdomain identifies your 
 InfluxDB Cloud cluster. For example:

-<pre class="highlight">
-https://<span class="bp" style="font-weight:bold;margin:0 .15rem">us-west-2-1</span>.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
-</pre>
+{{< code-callout "us-west-2-1" >}}
+```sh
+https://us-west-2-1.aws.cloud2.influxdata.com/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}
+
 {{% /note %}}

 {{< cloud_regions >}}
--- a/content/influxdb/cloud/visualize-data/dashboards/_index.md
+++ b/content/influxdb/cloud/visualize-data/dashboards/_index.md
@ -22,9 +22,11 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.

 When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

-<pre class="highlight">
-https://cloud2.influxdata.com/orgs/03a2bbf46249a000/dashboards/<span class="bp" style="font-weight:bold;margin:0 .15rem">04b6b15034cc000</span>/...
-</pre>
+{{< code-callout "04b6b15034cc000" >}}
+```sh
+https://cloud2.influxdata.com/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
+```
+{{< /code-callout >}}

 ### Dashboard ID in the CLI
 Use [`influx dashboards`](/influxdb/cloud/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
--- a/content/influxdb/v1.8/administration/backup_and_restore.md
+++ b/content/influxdb/v1.8/administration/backup_and_restore.md
--- a/content/influxdb/v2.0/organizations/view-orgs.md
+++ b/content/influxdb/v2.0/organizations/view-orgs.md
@ -41,9 +41,11 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.

 After logging in to the InfluxDB UI, your organization ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
-</pre>
+{{< code-callout "03a2bbf46249a000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}

 ### Organization ID in the CLI

--- a/content/influxdb/v2.0/visualize-data/dashboards/_index.md
+++ b/content/influxdb/v2.0/visualize-data/dashboards/_index.md
@ -22,9 +22,11 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.

 When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/03a2bbf46249a000/dashboards/<span class="bp" style="font-weight:bold;margin:0 .15rem">04b6b15034cc000</span>/...
-</pre>
+{{< code-callout "04b6b15034cc000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
+```
+{{< /code-callout >}}

 ### Dashboard ID in the CLI
 Use [`influx dashboards`](/influxdb/v2.0/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
--- a/content/influxdb/v2.1/organizations/view-orgs.md
+++ b/content/influxdb/v2.1/organizations/view-orgs.md
@ -41,9 +41,11 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.

 After logging in to the InfluxDB UI, your organization ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
-</pre>
+{{< code-callout "03a2bbf46249a000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}

 ### Organization ID in the CLI

--- a/content/influxdb/v2.1/visualize-data/dashboards/_index.md
+++ b/content/influxdb/v2.1/visualize-data/dashboards/_index.md
@ -22,9 +22,11 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.

 When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/03a2bbf46249a000/dashboards/<span class="bp" style="font-weight:bold;margin:0 .15rem">04b6b15034cc000</span>/...
-</pre>
+{{< code-callout "04b6b15034cc000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
+```
+{{< /code-callout >}}

 ### Dashboard ID in the CLI
 Use [`influx dashboards`](/influxdb/v2.1/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
--- a/content/influxdb/v2.2/organizations/view-orgs.md
+++ b/content/influxdb/v2.2/organizations/view-orgs.md
@ -41,9 +41,12 @@ Use the InfluxDB UI or `influx` CLI to view your organization ID.

 After logging in to the InfluxDB UI, your organization ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/<span class="bp" style="font-weight:bold;margin:0 .15rem">03a2bbf46249a000</span>/...
-</pre>
+{{< code-callout "03a2bbf46249a000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/...
+```
+{{< /code-callout >}}
+

 ### Organization ID in the CLI

--- a/content/influxdb/v2.2/visualize-data/dashboards/_index.md
+++ b/content/influxdb/v2.2/visualize-data/dashboards/_index.md
@ -22,9 +22,11 @@ Use the InfluxDB UI or `influx` CLI to view your dashboard ID.

 When viewing a dashboard in the InfluxDB UI, your dashboard ID appears in the URL.

-<pre class="highlight">
-http://localhost:8086/orgs/03a2bbf46249a000/dashboards/<span class="bp" style="font-weight:bold;margin:0 .15rem">04b6b15034cc000</span>/...
-</pre>
+{{< code-callout "04b6b15034cc000" >}}
+```sh
+http://localhost:8086/orgs/03a2bbf46249a000/dashboards/04b6b15034cc000/...
+```
+{{< /code-callout >}}

 ### Dashboard ID in the CLI
 Use [`influx dashboards`](/influxdb/v2.2/reference/cli/influx/dashboards/) to view a list of dashboards and IDs.
--- a/layouts/shortcodes/code-callout.html
+++ b/layouts/shortcodes/code-callout.html
@ -0,0 +1,4 @@
+{{- $regex := .Get 0 -}}
+{{- $code := .Inner | markdownify -}}
+{{- $codeCallout := replaceRE $regex "<span class='bp' style='font-weight:bold;margin:0 .15rem'>$0</span>" $code -}}
+{{ $codeCallout | safeHTML }}
--- a/layouts/shortcodes/latest-patch.html
+++ b/layouts/shortcodes/latest-patch.html
@ -5,9 +5,11 @@
 {{- $parsedVersion := replaceRE "v" "" (index $productPathData 1) -}}
 {{- $productArg := .Get "product" | default "" -}}
 {{- $versionArg := .Get "version" | default "" -}}
+{{- $minorVersionOffset := .Get "minorVersionOffset" | default 0 -}}
 {{- $product := cond (gt (len $productArg) 0) $productArg $parsedProduct -}}
 {{- $latestVersion := replaceRE "v" "" (index (index .Site.Data.products $product) "latest") -}}
-{{- $version := cond (gt (len $versionArg) 0) $versionArg (cond (ne $product $parsedProduct) $latestVersion $parsedVersion) -}}
+{{- $versionNoOffset := cond (gt (len $versionArg) 0) $versionArg (cond (ne $product $parsedProduct) $latestVersion $parsedVersion) -}}
+{{- $version := replaceRE `\d+$` (add (int (index (findRE `\d+$` $versionNoOffset) 0)) $minorVersionOffset) $versionNoOffset  -}}
 {{- $patchVersions := index (index .Site.Data.products $product) "latest_patches" -}}
 {{- $cliVersions := index .Site.Data.products.influxdb "latest_cli" -}}
 {{- if $cli }}
--- a/layouts/shortcodes/telegraf/plugins.html
+++ b/layouts/shortcodes/telegraf/plugins.html
@ -24,9 +24,7 @@
      <div class="info">
        <h3 id="{{ $type }}-{{ .id }}">{{ .name }}</h3>
        {{ if in .tags "external"}}
-          <a class="external" href="{{ $externalPluginLink }}">External
-            
-          </a>
+          <a class="external" href="{{ $externalPluginLink }}">External</a>
        {{ end }}
        <p class="meta">
          Plugin ID: <code>{{ $type }}s.{{ .id }}</code><br/>