From d8dc1ed0b21640994917dade928d7c1ef604eff3 Mon Sep 17 00:00:00 2001 From: Jeff Malnick Date: Mon, 14 Sep 2020 16:59:25 -0700 Subject: [PATCH] docs: refactor docs per guidelines (#341) --- website/data/docs-navigation.js | 14 +++++++++++--- website/pages/docs/architecture/index.mdx | 9 --------- website/pages/docs/architecture/terminology.mdx | 9 --------- website/pages/docs/installing/index.mdx | 11 +++++++++++ website/pages/docs/installing/installing.mdx | 9 +++++++++ .../concepts/actions.mdx | 0 .../concepts/auth-methods.mdx | 0 .../concepts/grants.mdx | 0 .../concepts/groups.mdx | 0 .../concepts/host-catalogs.mdx | 0 .../concepts/host-sets.mdx | 0 .../concepts/hosts.mdx | 0 .../concepts/index.mdx | 0 .../concepts/organization.mdx | 0 .../concepts/principals.mdx | 0 .../concepts/projects.mdx | 0 .../concepts/resources.mdx | 0 .../concepts/roles.mdx | 0 .../concepts/scopes.mdx | 0 .../concepts/targets.mdx | 0 .../concepts/users.mdx | 0 website/pages/docs/introduction/index.mdx | 11 +++++++++++ .../reference-architecture.mdx | 0 .../security-model.mdx | 0 website/pages/docs/releases/downloads.mdx | 11 +++++++++++ website/pages/docs/releases/index.mdx | 11 +++++++++++ website/pages/docs/releases/release-notes.mdx | 11 +++++++++++ 27 files changed, 75 insertions(+), 21 deletions(-) delete mode 100644 website/pages/docs/architecture/index.mdx delete mode 100644 website/pages/docs/architecture/terminology.mdx create mode 100644 website/pages/docs/installing/index.mdx create mode 100644 website/pages/docs/installing/installing.mdx rename website/pages/docs/{architecture => introduction}/concepts/actions.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/auth-methods.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/grants.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/groups.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/host-catalogs.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/host-sets.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/hosts.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/index.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/organization.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/principals.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/projects.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/resources.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/roles.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/scopes.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/targets.mdx (100%) rename website/pages/docs/{architecture => introduction}/concepts/users.mdx (100%) create mode 100644 website/pages/docs/introduction/index.mdx rename website/pages/docs/{architecture => introduction}/reference-architecture.mdx (100%) rename website/pages/docs/{architecture => introduction}/security-model.mdx (100%) create mode 100644 website/pages/docs/releases/downloads.mdx create mode 100644 website/pages/docs/releases/index.mdx create mode 100644 website/pages/docs/releases/release-notes.mdx diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index bed4b0a5de..e85a6e8147 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -8,7 +8,7 @@ export default [ { - category: 'architecture', + category: 'introduction', content: [ 'security-model', 'reference-architecture', @@ -35,17 +35,25 @@ export default [ ], }, { - category: 'command-line', - content: ['login'], + category: 'installing', + content: ['installing'], }, { category: 'admin-console', content: ['login'], }, + { + category: 'command-line', + content: ['login'], + }, { category: 'sdk', content: ['login'], }, + { + category: 'releases', + content: ['release-notes', 'downloads'], + }, '---', { title: 'External Link', href: 'https://www.hashicorp.com' }, diff --git a/website/pages/docs/architecture/index.mdx b/website/pages/docs/architecture/index.mdx deleted file mode 100644 index b4b94c8f42..0000000000 --- a/website/pages/docs/architecture/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: docs -page_title: Architecture Index -sidebar_title: Architecture -description: |- - Write a description here, this appears in search engines and social shares ---- - -# Architecture Overview diff --git a/website/pages/docs/architecture/terminology.mdx b/website/pages/docs/architecture/terminology.mdx deleted file mode 100644 index d60dc1c942..0000000000 --- a/website/pages/docs/architecture/terminology.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: docs -page_title: Architecture -sidebar_title: Terminology -description: |- - Boundary terminology ---- - -# Terminology diff --git a/website/pages/docs/installing/index.mdx b/website/pages/docs/installing/index.mdx new file mode 100644 index 0000000000..ff0401e77b --- /dev/null +++ b/website/pages/docs/installing/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Installing Boundary +sidebar_title: Installing +description: |- + How to install boundary. +--- + +# Overview + +Installing Boundary is easy! diff --git a/website/pages/docs/installing/installing.mdx b/website/pages/docs/installing/installing.mdx new file mode 100644 index 0000000000..e2894a1e6b --- /dev/null +++ b/website/pages/docs/installing/installing.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Installing Boundary +sidebar_title: Installing +description: |- + How to install Boundary +--- + +# How to install Boundary diff --git a/website/pages/docs/architecture/concepts/actions.mdx b/website/pages/docs/introduction/concepts/actions.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/actions.mdx rename to website/pages/docs/introduction/concepts/actions.mdx diff --git a/website/pages/docs/architecture/concepts/auth-methods.mdx b/website/pages/docs/introduction/concepts/auth-methods.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/auth-methods.mdx rename to website/pages/docs/introduction/concepts/auth-methods.mdx diff --git a/website/pages/docs/architecture/concepts/grants.mdx b/website/pages/docs/introduction/concepts/grants.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/grants.mdx rename to website/pages/docs/introduction/concepts/grants.mdx diff --git a/website/pages/docs/architecture/concepts/groups.mdx b/website/pages/docs/introduction/concepts/groups.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/groups.mdx rename to website/pages/docs/introduction/concepts/groups.mdx diff --git a/website/pages/docs/architecture/concepts/host-catalogs.mdx b/website/pages/docs/introduction/concepts/host-catalogs.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/host-catalogs.mdx rename to website/pages/docs/introduction/concepts/host-catalogs.mdx diff --git a/website/pages/docs/architecture/concepts/host-sets.mdx b/website/pages/docs/introduction/concepts/host-sets.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/host-sets.mdx rename to website/pages/docs/introduction/concepts/host-sets.mdx diff --git a/website/pages/docs/architecture/concepts/hosts.mdx b/website/pages/docs/introduction/concepts/hosts.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/hosts.mdx rename to website/pages/docs/introduction/concepts/hosts.mdx diff --git a/website/pages/docs/architecture/concepts/index.mdx b/website/pages/docs/introduction/concepts/index.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/index.mdx rename to website/pages/docs/introduction/concepts/index.mdx diff --git a/website/pages/docs/architecture/concepts/organization.mdx b/website/pages/docs/introduction/concepts/organization.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/organization.mdx rename to website/pages/docs/introduction/concepts/organization.mdx diff --git a/website/pages/docs/architecture/concepts/principals.mdx b/website/pages/docs/introduction/concepts/principals.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/principals.mdx rename to website/pages/docs/introduction/concepts/principals.mdx diff --git a/website/pages/docs/architecture/concepts/projects.mdx b/website/pages/docs/introduction/concepts/projects.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/projects.mdx rename to website/pages/docs/introduction/concepts/projects.mdx diff --git a/website/pages/docs/architecture/concepts/resources.mdx b/website/pages/docs/introduction/concepts/resources.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/resources.mdx rename to website/pages/docs/introduction/concepts/resources.mdx diff --git a/website/pages/docs/architecture/concepts/roles.mdx b/website/pages/docs/introduction/concepts/roles.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/roles.mdx rename to website/pages/docs/introduction/concepts/roles.mdx diff --git a/website/pages/docs/architecture/concepts/scopes.mdx b/website/pages/docs/introduction/concepts/scopes.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/scopes.mdx rename to website/pages/docs/introduction/concepts/scopes.mdx diff --git a/website/pages/docs/architecture/concepts/targets.mdx b/website/pages/docs/introduction/concepts/targets.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/targets.mdx rename to website/pages/docs/introduction/concepts/targets.mdx diff --git a/website/pages/docs/architecture/concepts/users.mdx b/website/pages/docs/introduction/concepts/users.mdx similarity index 100% rename from website/pages/docs/architecture/concepts/users.mdx rename to website/pages/docs/introduction/concepts/users.mdx diff --git a/website/pages/docs/introduction/index.mdx b/website/pages/docs/introduction/index.mdx new file mode 100644 index 0000000000..0ef1121ea8 --- /dev/null +++ b/website/pages/docs/introduction/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Introduction Index +sidebar_title: Introduction +description: |- + An introduction to Boundary including concepts and architecture. +--- + +# Introduction + +Lorum ipsum diff --git a/website/pages/docs/architecture/reference-architecture.mdx b/website/pages/docs/introduction/reference-architecture.mdx similarity index 100% rename from website/pages/docs/architecture/reference-architecture.mdx rename to website/pages/docs/introduction/reference-architecture.mdx diff --git a/website/pages/docs/architecture/security-model.mdx b/website/pages/docs/introduction/security-model.mdx similarity index 100% rename from website/pages/docs/architecture/security-model.mdx rename to website/pages/docs/introduction/security-model.mdx diff --git a/website/pages/docs/releases/downloads.mdx b/website/pages/docs/releases/downloads.mdx new file mode 100644 index 0000000000..d6afeb8271 --- /dev/null +++ b/website/pages/docs/releases/downloads.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Downloads +sidebar_title: Downloads +description: |- + Boundary downloads for releases +--- + +# Downloads + +Lorum ipsum diff --git a/website/pages/docs/releases/index.mdx b/website/pages/docs/releases/index.mdx new file mode 100644 index 0000000000..b08b340466 --- /dev/null +++ b/website/pages/docs/releases/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Releases +sidebar_title: Releases +description: |- + Boundary releases +--- + +# Overview + +Boundary releases... diff --git a/website/pages/docs/releases/release-notes.mdx b/website/pages/docs/releases/release-notes.mdx new file mode 100644 index 0000000000..7ac11e871e --- /dev/null +++ b/website/pages/docs/releases/release-notes.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Release Notes +sidebar_title: Release Notes +description: |- + Boundary Release Notes +--- + +# Release Notes + +Lorum ipsum