diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e99320ae..b3f3243f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -240,3 +240,26 @@ to seeing the full content block. Truncated markdown content here. {{% /truncate %}} ``` + +### Reference content +The InfluxDB documentation is "task-based," meaning content primarily focuses on +what a user is **doing**, not what they are **using**. +However, there is a need to document tools and other things that don't necessarily +fit in the task-based style. +This is referred to as "reference content." + +Reference content is styled just as the rest of the InfluxDB documentation. +The only difference is the `menu` reference in the page's frontmatter. +When defining the menu for reference content, use the following pattern: + +```yaml +# Pattern +menu: + v__ref: + # ... + +# Example +menu: + v2_0_ref: + # ... +``` diff --git a/assets/js/content-interactions.js b/assets/js/content-interactions.js index e10316967..e6b312ac8 100644 --- a/assets/js/content-interactions.js +++ b/assets/js/content-interactions.js @@ -1,6 +1,10 @@ ///////////////////////////// Make headers linkable ///////////////////////////// -$("h2,h3,h4,h5,h6").each(function() { +$(".article--content h2, \ + .article--content h3, \ + .article--content h4, \ + .article--content h5, \ + .article--content h6" ).each(function() { var link = "" $(this).wrapInner( link ); }) diff --git a/assets/styles/layouts/_layout-sidebar.scss b/assets/styles/layouts/_layout-sidebar.scss index 087c4916d..d7a426f5b 100644 --- a/assets/styles/layouts/_layout-sidebar.scss +++ b/assets/styles/layouts/_layout-sidebar.scss @@ -207,6 +207,17 @@ &:after { transform: rotate(180deg); } } } + + // Reference title styles + h4 { + margin: 2rem 0 0 -1rem; + color: rgba($article-heading, .8); + font-style: italic; + font-weight: 700; + text-transform: uppercase; + font-size: .85rem; + letter-spacing: .08rem; + } } } diff --git a/content/v2.0/reference/cli/_index.md b/content/v2.0/reference/cli/_index.md new file mode 100644 index 000000000..dde15e9e7 --- /dev/null +++ b/content/v2.0/reference/cli/_index.md @@ -0,0 +1,11 @@ +--- +title: Command line tools +seotitle: Command line tools for managing InfluxDB +description: InfluxDB comes with command line tools meant to aid in managing and working with InfluxDB. +menu: + v2_0_ref: + name: Command line tools + weight: 1 +--- + +_Placeholder for command line content._ diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html index e35a13214..1c4fb838d 100644 --- a/layouts/partials/sidebar.html +++ b/layouts/partials/sidebar.html @@ -97,5 +97,84 @@ {{ end }} {{end}} + + + {{ $refMenuID := print (replaceRE "[.]" "_" $currentVersion) "_ref" }} +

Reference

+ + {{ range (index .Site.Menus $refMenuID) }} + + + {{end}} + +