diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17dd47c5e..9e07dce81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,13 +59,16 @@ menu: v2_0: name: # Article name that only appears in the left nav parent: # Specifies a parent group and nests navigation items -weight: # Determines sort order in both the nav tree and in article lists. +weight: # Determines sort order in both the nav tree and in article lists draft: # If true, will not render page on build enterprise_all: # If true, specifies the doc as a whole is specific to InfluxDB Enterprise enterprise_some: # If true, specifies the doc includes some content specific to InfluxDB Enterprise cloud_all: # If true, specifies the doc as a whole is specific to InfluxDB Cloud cloud_some: # If true, specifies the doc includes some content specific to InfluxDB Cloud v2.x/tags: # Tags specific to each version (replace .x" with the appropriate minor version ) +related: # Creates links to specific internal and external content at the bottom of the page + - /path/to/related/article + - https://external-link.com, This is an external link ``` #### Title usage @@ -310,6 +313,20 @@ WHERE time > now() - 15m {{< /code-tabs-wrapper >}} ~~~ +### Related content +Use the `related` frontmatter to include links to specific articles at the bottom of an article. + +- If the page exists inside of this documentation, just include the path to the page. + It will automatically detect the title of the page. +- If the page exists outside of this documentation, include the full URL and a title for the link. + The link and title must be in that order and must be separated by a comma and a space. + +```yaml +related: + - /v2.0/write-data/quick-start + - https://influxdata.com, This is an external link +``` + ### High-resolution images In many cases, screenshots included in the docs are taken from high-resolution (retina) screens. Because of this, the actual pixel dimension is 2x larger than it needs to be and is rendered 2x bigger than it should be. diff --git a/assets/styles/layouts/_article.scss b/assets/styles/layouts/_article.scss index 7d36aad37..52554daf2 100644 --- a/assets/styles/layouts/_article.scss +++ b/assets/styles/layouts/_article.scss @@ -106,6 +106,7 @@ "article/lists", "article/note", "article/pagination-btns", + "article/related", "article/scrollbars", "article/tabbed-content", "article/tables", diff --git a/assets/styles/layouts/article/_related.scss b/assets/styles/layouts/article/_related.scss new file mode 100644 index 000000000..fa8d8e14c --- /dev/null +++ b/assets/styles/layouts/article/_related.scss @@ -0,0 +1,15 @@ +.related { + border-top: 1px solid $article-hr; + padding-top: 1.5rem; + + h4 { font-size: 1.15rem; } + ul { + list-style: none; + padding: 0; + margin-top: 0; + } + li { + margin: .5rem 0; + line-height: 1.25rem; + } +} diff --git a/assets/styles/layouts/article/_tags.scss b/assets/styles/layouts/article/_tags.scss index 8c22756d8..f56f731d4 100644 --- a/assets/styles/layouts/article/_tags.scss +++ b/assets/styles/layouts/article/_tags.scss @@ -2,8 +2,8 @@ .tags { border-top: 1px solid $article-hr; - padding-top: 1.5rem; - margin-top: 2rem; + padding-top: 1.75rem; + margin: 2rem 0 1rem; .tag { background: $body-bg; @@ -15,3 +15,9 @@ font-size: .8rem; } } + +.related + .tags { + border: none; + padding-top: 0; + margin: 1.5rem 0 1rem; +} diff --git a/content/v2.0/cloud/get-started.md b/content/v2.0/cloud/get-started.md index d8d2d25a4..f80c1149d 100644 --- a/content/v2.0/cloud/get-started.md +++ b/content/v2.0/cloud/get-started.md @@ -7,6 +7,7 @@ menu: v2_0_cloud: name: Get started with InfluxDB Cloud --- + {{< cloud-name >}} is a fully managed and hosted version of the InfluxDB 2.0. To get started, complete the tasks below. diff --git a/content/v2.0/example.md b/content/v2.0/example.md index 34d49116b..db9bf55df 100644 --- a/content/v2.0/example.md +++ b/content/v2.0/example.md @@ -10,7 +10,11 @@ enterprise_all: true #cloud_all: true cloud_some: true draft: true -"v2.0/tags": [influxdb] +"v2.0/tags": [influxdb, functions] +related: + - /v2.0/write-data/ + - /v2.0/write-data/quick-start + - https://influxdata.com, This is an external link --- This is a paragraph. Lorem ipsum dolor ({{< icon "trash" >}}) sit amet, consectetur adipiscing elit. Nunc rutrum, metus id scelerisque euismod, erat ante suscipit nibh, ac congue enim risus id est. Etiam tristique nisi et tristique auctor. Morbi eu bibendum erat. Sed ullamcorper, dui id lobortis efficitur, mauris odio pharetra neque, vel tempor odio dolor blandit justo. diff --git a/content/v2.0/process-data/manage-tasks/create-task.md b/content/v2.0/process-data/manage-tasks/create-task.md index c2e0753e5..f8ef8dc3a 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -8,6 +8,8 @@ menu: name: Create a task parent: Manage tasks weight: 201 +related: + - /v2.0/reference/cli/influx/task/create --- InfluxDB provides multiple ways to create tasks both in the InfluxDB user interface (UI) diff --git a/content/v2.0/process-data/manage-tasks/delete-task.md b/content/v2.0/process-data/manage-tasks/delete-task.md index f89b0981e..eab5c0a54 100644 --- a/content/v2.0/process-data/manage-tasks/delete-task.md +++ b/content/v2.0/process-data/manage-tasks/delete-task.md @@ -8,6 +8,8 @@ menu: name: Delete a task parent: Manage tasks weight: 206 +related: + - /v2.0/reference/cli/influx/task/delete --- ## Delete a task in the InfluxDB UI diff --git a/content/v2.0/process-data/manage-tasks/run-task.md b/content/v2.0/process-data/manage-tasks/run-task.md index ec975adf7..297ca4308 100644 --- a/content/v2.0/process-data/manage-tasks/run-task.md +++ b/content/v2.0/process-data/manage-tasks/run-task.md @@ -8,6 +8,9 @@ menu: name: Run a task parent: Manage tasks weight: 203 +related: + - /v2.0/reference/cli/influx/task/run + - /v2.0/reference/cli/influx/task/retry --- InfluxDB data processing tasks generally run in defined intervals or at a specific time, diff --git a/content/v2.0/process-data/manage-tasks/task-run-history.md b/content/v2.0/process-data/manage-tasks/task-run-history.md index ee4cae300..5539fc32d 100644 --- a/content/v2.0/process-data/manage-tasks/task-run-history.md +++ b/content/v2.0/process-data/manage-tasks/task-run-history.md @@ -7,6 +7,8 @@ menu: name: View run history parent: Manage tasks weight: 203 +related: + - /v2.0/reference/cli/influx/task/run/find --- When an InfluxDB task runs, a "run" record is created in the task's history. diff --git a/content/v2.0/process-data/manage-tasks/update-task.md b/content/v2.0/process-data/manage-tasks/update-task.md index 255e35331..f6312c8b8 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -8,6 +8,8 @@ menu: name: Update a task parent: Manage tasks weight: 204 +related: + - /v2.0/reference/cli/influx/task/update --- ## Update a task in the InfluxDB UI diff --git a/content/v2.0/process-data/manage-tasks/view-tasks.md b/content/v2.0/process-data/manage-tasks/view-tasks.md index 8aecb45e2..2c8c91083 100644 --- a/content/v2.0/process-data/manage-tasks/view-tasks.md +++ b/content/v2.0/process-data/manage-tasks/view-tasks.md @@ -8,6 +8,8 @@ menu: name: View tasks parent: Manage tasks weight: 202 +related: + - /v2.0/reference/cli/influx/task/find --- ## View tasks in the InfluxDB UI diff --git a/content/v2.0/query-data/get-started/_index.md b/content/v2.0/query-data/get-started/_index.md index 4c85cf503..56162f606 100644 --- a/content/v2.0/query-data/get-started/_index.md +++ b/content/v2.0/query-data/get-started/_index.md @@ -9,6 +9,9 @@ menu: v2_0: name: Get started with Flux parent: Query data +related: + - /v2.0/reference/flux/ + - /v2.0/reference/flux/functions/ --- Flux is InfluxData's functional data scripting language designed for querying, diff --git a/content/v2.0/query-data/get-started/query-influxdb.md b/content/v2.0/query-data/get-started/query-influxdb.md index 2534cbe29..f454e2d93 100644 --- a/content/v2.0/query-data/get-started/query-influxdb.md +++ b/content/v2.0/query-data/get-started/query-influxdb.md @@ -7,6 +7,11 @@ menu: name: Query InfluxDB parent: Get started with Flux weight: 201 +related: + - /v2.0/query-data/guides/ + - /v2.0/reference/flux/functions/built-in/inputs/from + - /v2.0/reference/flux/functions/built-in/transformations/range + - /v2.0/reference/flux/functions/built-in/transformations/filter --- This guide walks through the basics of using Flux to query data from InfluxDB. diff --git a/content/v2.0/query-data/get-started/syntax-basics.md b/content/v2.0/query-data/get-started/syntax-basics.md index a4c58c9f4..fb21dea63 100644 --- a/content/v2.0/query-data/get-started/syntax-basics.md +++ b/content/v2.0/query-data/get-started/syntax-basics.md @@ -7,6 +7,8 @@ menu: name: Syntax basics parent: Get started with Flux weight: 203 +related: + - /v2.0/reference/flux/language/types/ --- diff --git a/content/v2.0/query-data/get-started/transform-data.md b/content/v2.0/query-data/get-started/transform-data.md index 5dff2d320..534544858 100644 --- a/content/v2.0/query-data/get-started/transform-data.md +++ b/content/v2.0/query-data/get-started/transform-data.md @@ -7,6 +7,9 @@ menu: name: Transform data parent: Get started with Flux weight: 202 +related: + - /v2.0/reference/flux/functions/built-in/transformations/aggregates/aggregatewindow + - /v2.0/reference/flux/functions/built-in/transformations/window --- When [querying data from InfluxDB](/v2.0/query-data/get-started/query-influxdb), diff --git a/layouts/partials/article.html b/layouts/partials/article.html index 21aed2ab4..5eb869b3c 100644 --- a/layouts/partials/article.html +++ b/layouts/partials/article.html @@ -5,6 +5,7 @@ {{ partial "article/enterprise.html" . }} {{ partial "article/cloud.html" . }} {{ .Content }} + {{ partial "article/related.html" . }} {{ partial "article/tags.html" . }} {{ if in .RelPermalink "/cloud/"}} diff --git a/layouts/partials/article/related.html b/layouts/partials/article/related.html new file mode 100644 index 000000000..7bbe046e0 --- /dev/null +++ b/layouts/partials/article/related.html @@ -0,0 +1,19 @@ +{{ if .Params.related }} +
+ + +
+{{ end }}