From d8de2d6b2e766b77cf40e31cc16bd65510659dd5 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Thu, 19 Nov 2020 09:43:29 -0500 Subject: [PATCH] docs: move telemetry under operations Create a new "Operating Nomad" section of the docs where we can put reference material for operators that doesn't quite fit in either configuration file / command line documentation or a step-by-step Learn Guide. Pre-populate this with the existing telemetry docs and some links out to the Learn Guide sections. --- website/data/docs-navigation.js | 20 ++++++++++++++++++- website/pages/docs/operations/index.mdx | 19 ++++++++++++++++++ .../{telemetry => operations}/metrics.mdx | 0 .../index.mdx => operations/telemetry.mdx} | 0 website/redirects.js | 16 +++++++++++++-- 5 files changed, 52 insertions(+), 3 deletions(-) create mode 100644 website/pages/docs/operations/index.mdx rename website/pages/docs/{telemetry => operations}/metrics.mdx (100%) rename website/pages/docs/{telemetry/index.mdx => operations/telemetry.mdx} (100%) diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 4af40c48c..9371f9de2 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -280,7 +280,25 @@ export default [ }, ], }, - {category: 'telemetry', content: ['metrics']}, + { + category: 'operations', + content: [ + 'telemetry', + 'metrics', + { + title: 'Cluster Management', + href: 'https://learn.hashicorp.com/collections/nomad/manage-clusters' + }, + { + title: 'Transport Security', + href: 'https://learn.hashicorp.com/collections/nomad/transport-security' + }, + { + title: 'Access Control', + href: 'https://learn.hashicorp.com/collections/nomad/access-control' + } + ] + }, '------------', 'enterprise', 'faq', diff --git a/website/pages/docs/operations/index.mdx b/website/pages/docs/operations/index.mdx new file mode 100644 index 000000000..1d5e1d592 --- /dev/null +++ b/website/pages/docs/operations/index.mdx @@ -0,0 +1,19 @@ +--- +layout: docs +page_title: Operations +description: |- + Learn about operating Nomad. +--- + +# Operations + +This section includes references on how to operate Nomad in production. To +learn more, choose an item from the sidebar, or choose one of the options +below: + + +- [Telemetry Overview](/docs/operations/telemetry) +- [Metrics](/docs/operations/metrics) +- [Cluster Management](https://learn.hashicorp.com/collections/nomad/manage-clusters) +- [Transport Security](https://learn.hashicorp.com/collections/nomad/transport-security) +- [Access Control](https://learn.hashicorp.com/collections/nomad/access-control) diff --git a/website/pages/docs/telemetry/metrics.mdx b/website/pages/docs/operations/metrics.mdx similarity index 100% rename from website/pages/docs/telemetry/metrics.mdx rename to website/pages/docs/operations/metrics.mdx diff --git a/website/pages/docs/telemetry/index.mdx b/website/pages/docs/operations/telemetry.mdx similarity index 100% rename from website/pages/docs/telemetry/index.mdx rename to website/pages/docs/operations/telemetry.mdx diff --git a/website/redirects.js b/website/redirects.js index 1569ef0a4..16e73da8e 100644 --- a/website/redirects.js +++ b/website/redirects.js @@ -4,8 +4,8 @@ module.exports = [ // Playground for testing url pattern matching: https://npm.runkit.com/path-to-regexp { - source: '/docs/telemetry/overview', - destination: '/docs/telemetry', + source: '/docs/operations/overview', + destination: '/docs/operations', permanent: true, }, @@ -804,6 +804,18 @@ module.exports = [ destination: '/docs/configuration/vault', permanent: true, }, + // Moved telemetry under operations + { + source: '/docs/telemetry', + destination: '/docs/operations/telemetry', + permanent: true, + }, + + { + source: '/docs/telemetry/metrics', + destination: '/docs/operations/metrics', + permanent: true, + }, // Moved guide-like docs to /guides {