Merge pull request #105 from influxdata/layout/list-name
list_title frontmatter and shortcode supportpull/108/head
Scott Anderson
GitHub
commit
fd1e3955e5
|
|
@ -53,6 +53,7 @@ Frontmatter populates variables in page templates and the site's navigation menu
|
|||
```yaml
|
||||
title: # Title of the page used in the page's h1
|
||||
seotitle: # Page title used in the html <head> title and used in search engine results
|
||||
list_title: # Title used in article lists generated using the {{< children >}} shortcode
|
||||
description: # Page description displayed in search engine results
|
||||
menu:
|
||||
v2_0:
|
||||
|
|
@ -77,6 +78,10 @@ It shouldn't be overly long, but should set the context for users coming from ou
|
|||
The `seotitle` frontmatter populates each page's HTML `title` attribute.
|
||||
Search engines use this in search results (not the page's h1) and therefore it should be keyword optimized.
|
||||
|
||||
##### `list_title`
|
||||
The `list_title` frontmatter determines an article title when in a list generated
|
||||
by the [`{{< children >}}` shortcode](#generate-a-list-of-children-articles).
|
||||
|
||||
##### `menu > name`
|
||||
The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation.
|
||||
It should be short and assume the context of its parent if it has one.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Quick start to data collection
|
||||
list_title: Quick start
|
||||
description: >
|
||||
Use "Quick Start" in the initial InfluxDB setup process to create a scraper
|
||||
that collects InfluxDB metrics from the InfluxDB `/metrics` endpoint.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
title: Use Telegraf to collect data
|
||||
weight: 102
|
||||
seotitle: Use Telegraf to collect and write data
|
||||
list_title: Use Telegraf
|
||||
weight: 102
|
||||
description: >
|
||||
Use Telegraf to collect and write data to InfluxDB v2.0.
|
||||
Create Telegraf configurations in the InfluxDB UI or manually configure Telegraf.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in functions
|
||||
list_title: Built-in functions
|
||||
description: >
|
||||
Built-in functions provide a necessary foundation for working with data using Flux.
|
||||
They do not require an import statement and are usable without any extra setup.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in input functions
|
||||
list_title: Built-in input functions
|
||||
description: Flux's built-in input functions define sources of data or or display information about data sources.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/inputs
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in miscellaneous functions
|
||||
list_title: Built-in miscellaneous functions
|
||||
description: >
|
||||
Flux provides built-in miscellaneous functions that serve purposes other than
|
||||
retrieving, transforming, or outputting data.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in output functions
|
||||
list_title: Built-in output functions
|
||||
description: Flux's built-in output functions yield results or send data to a specified output destination.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/outputs
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in testing functions
|
||||
list_title: Built-in testing functions
|
||||
description: Flux's built-in testing functions test various aspects of piped-forward data.
|
||||
menu:
|
||||
v2_0_ref:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in transformation functions
|
||||
list_title: Built-in transformation functions
|
||||
description: Flux's built-in transformation functions transform and shape your data in specific ways.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/transformations
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in aggregate functions
|
||||
list_title: Built-in aggregate functions
|
||||
description: Flux's built-in aggregate functions take values from an input table and aggregate them in some way.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/transformations/aggregates
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in selector functions
|
||||
list_title: Built-in selector functions
|
||||
description: Flux's built-in selector functions return one or more records based on function logic.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/transformations/selectors
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux built-in type conversion functions
|
||||
list_title: Built-in type conversion functions
|
||||
description: Flux's built-in built-in type conversion functions convert columns of the input table into a specific data type.
|
||||
aliases:
|
||||
- /v2.0/reference/flux/functions/transformations/type-conversions
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux InfluxDB v1 functions
|
||||
list_title: InfluxDB v1 functions
|
||||
description: >
|
||||
InfluxDB v1 Flux functions provide tools for managing data from an InfluxDB v1.x
|
||||
database or structured using the InfluxDB v1 data structure.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux string functions
|
||||
list_title: String functions
|
||||
description: >
|
||||
String functions provide tools for manipulating strings in Flux.
|
||||
To use them, import the `strings` package.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Flux testing functions
|
||||
list_title: Testing functions
|
||||
description: >
|
||||
Flux testing functions test piped-forward data in specific ways and return errors if the tests fail.
|
||||
To use them, import the `testing` package.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
{{ if eq $type "articles" }}
|
||||
|
||||
{{ range $pages.ByWeight }}
|
||||
<h3><a href="{{ .RelPermalink }}" >{{ .Title }}</a></h3>
|
||||
<h3><a href="{{ .RelPermalink }}" >{{ if .Params.list_title }}{{ .Params.list_title }}{{ else }}{{ .Title }}{{ end }}</a></h3>
|
||||
<p>
|
||||
{{- if .Description }}{{- .Description | markdownify -}}
|
||||
{{ else }}{{- .Summary | markdownify -}}
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<ul>
|
||||
{{ range $pages.ByWeight }}
|
||||
{{ $title := replaceRE `\ function` "" .Title }}
|
||||
<li><a href="{{ .RelPermalink }}">{{ $title }}</a></li>
|
||||
<li><a href="{{ .RelPermalink }}">{{ if .Params.list_title }}{{ .Params.list_title }}{{ else }}{{ $title }}{{ end }}</a></li>
|
||||
{{ end }}
|
||||
<ul>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue