From 7eaf6d6d485bde005f520704a1ba9ee0b4322485 Mon Sep 17 00:00:00 2001 From: Jeff Malnick Date: Tue, 6 Oct 2020 15:18:48 -0700 Subject: [PATCH] docs: move standards into their own sub-section (#560) --- .../{standards => api-standards}/cli-standards.mdx | 4 ++-- .../http-standards.mdx} | 8 ++++---- .../concepts/{standards => api-standards}/index.mdx | 4 ++-- website/content/docs/concepts/security-model.mdx | 9 --------- .../content/docs/concepts/security-model/index.mdx | 11 +++++++++++ .../permissions-model.mdx} | 8 ++++---- website/data/docs-navigation.js | 12 ++++++++---- 7 files changed, 31 insertions(+), 25 deletions(-) rename website/content/docs/concepts/{standards => api-standards}/cli-standards.mdx (98%) rename website/content/docs/concepts/{standards/api-standards.mdx => api-standards/http-standards.mdx} (98%) rename website/content/docs/concepts/{standards => api-standards}/index.mdx (52%) delete mode 100644 website/content/docs/concepts/security-model.mdx create mode 100644 website/content/docs/concepts/security-model/index.mdx rename website/content/docs/concepts/{permissions.mdx => security-model/permissions-model.mdx} (99%) diff --git a/website/content/docs/concepts/standards/cli-standards.mdx b/website/content/docs/concepts/api-standards/cli-standards.mdx similarity index 98% rename from website/content/docs/concepts/standards/cli-standards.mdx rename to website/content/docs/concepts/api-standards/cli-standards.mdx index 40d906ab8..f52e7f146 100644 --- a/website/content/docs/concepts/standards/cli-standards.mdx +++ b/website/content/docs/concepts/api-standards/cli-standards.mdx @@ -6,7 +6,7 @@ description: |- Boundary's CLI standards --- -# Overview +# CLI Standards Boundary's CLI has predictable behavior throughout its various commands. This page details these standards to help users make better use of the CLI. @@ -77,4 +77,4 @@ Boundary's CLI supports autocompletion. For Bash, the following line in a `~/.ba `complete -C /path/to/boundary boundary` -This will allow tab completion of commands, flags, and in some cases the parameters to those flags. \ No newline at end of file +This will allow tab completion of commands, flags, and in some cases the parameters to those flags. diff --git a/website/content/docs/concepts/standards/api-standards.mdx b/website/content/docs/concepts/api-standards/http-standards.mdx similarity index 98% rename from website/content/docs/concepts/standards/api-standards.mdx rename to website/content/docs/concepts/api-standards/http-standards.mdx index ab5921acf..f8ddb58b7 100644 --- a/website/content/docs/concepts/standards/api-standards.mdx +++ b/website/content/docs/concepts/api-standards/http-standards.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: API Standards -sidebar_title: API Standards +page_title: HTTP API Standards +sidebar_title: HTTP API Standards description: |- - Boundary's API standards + Boundary's HTTP API standards --- -# Overview +# HTTP API Standards Boundary's HTTP API adheres to a set of standards that are rigidly followed. At its core, it is a standards-compliant JSON API for both input and output. diff --git a/website/content/docs/concepts/standards/index.mdx b/website/content/docs/concepts/api-standards/index.mdx similarity index 52% rename from website/content/docs/concepts/standards/index.mdx rename to website/content/docs/concepts/api-standards/index.mdx index b9df5bae8..ebc28ad5e 100644 --- a/website/content/docs/concepts/standards/index.mdx +++ b/website/content/docs/concepts/api-standards/index.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Concepts - Standards +page_title: API Standards sidebar_title: API Standards description: |- An introduction to Boundary API standards. @@ -8,4 +8,4 @@ description: |- # Boundary API Standards -This section covers our API standards including command line, and other API interactions. +This section covers our API standards including command line and HTTP API. diff --git a/website/content/docs/concepts/security-model.mdx b/website/content/docs/concepts/security-model.mdx deleted file mode 100644 index 5a62560d4..000000000 --- a/website/content/docs/concepts/security-model.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: docs -page_title: Architecture -sidebar_title: Security Model -description: |- - Boundary security model ---- - -# Overview diff --git a/website/content/docs/concepts/security-model/index.mdx b/website/content/docs/concepts/security-model/index.mdx new file mode 100644 index 000000000..72057119f --- /dev/null +++ b/website/content/docs/concepts/security-model/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Security Model +sidebar_title: Security Model +description: |- + Boundary security model overview. +--- + +# Security Model + +This section describes the security models that Boundary follows. Here you can find in-depth analysis about how permissions, identity, and target security are handled within the Boundary product. diff --git a/website/content/docs/concepts/permissions.mdx b/website/content/docs/concepts/security-model/permissions-model.mdx similarity index 99% rename from website/content/docs/concepts/permissions.mdx rename to website/content/docs/concepts/security-model/permissions-model.mdx index 6713bec56..9221f94c2 100644 --- a/website/content/docs/concepts/permissions.mdx +++ b/website/content/docs/concepts/security-model/permissions-model.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Permissions -sidebar_title: Permissions +page_title: Permissions Model +sidebar_title: Permissions Model description: |- Boundary's permissions model --- -# Overview +# Boundary Permissions Model Boundary's permissions model is a composable, RBAC, allow-only model that attempts to marry flexibility with usability. This page discusses the permission @@ -1299,4 +1299,4 @@ wildcard or templated grant strings. - \ No newline at end of file + diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index b4a419bd3..b56c91e22 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -29,7 +29,12 @@ export default [ { category: 'concepts', content: [ - 'security-model', + { + category: 'security-model', + content: [ + 'permissions-model', + ] + }, { category: 'domain-model', content: [ @@ -52,13 +57,12 @@ export default [ ], }, { - category: 'standards', + category: 'api-standards', content: [ - 'api-standards', + 'http-standards', 'cli-standards', ] }, - 'permissions', ], }, '---',