From 8f5c364bdef732abb85a857d19b8d705a8366bba Mon Sep 17 00:00:00 2001 From: Jeff Malnick Date: Fri, 31 Jul 2020 11:05:04 -0700 Subject: [PATCH] docs: refactor architecture section to be more aligned with other docs sites (#235) --- website/data/docs-navigation.js | 42 ++++++++++--------- .../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 .../pages/docs/architecture/domain-model.mdx | 9 ---- ...loyment.mdx => reference-architecture.mdx} | 6 +-- .../{ => architecture}/security-model.mdx | 2 +- 20 files changed, 26 insertions(+), 33 deletions(-) rename website/pages/docs/{domain-model => architecture/concepts}/actions.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/auth-methods.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/grants.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/groups.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/host-catalogs.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/host-sets.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/hosts.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/index.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/organization.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/principals.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/projects.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/resources.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/roles.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/scopes.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/targets.mdx (100%) rename website/pages/docs/{domain-model => architecture/concepts}/users.mdx (100%) delete mode 100644 website/pages/docs/architecture/domain-model.mdx rename website/pages/docs/architecture/{reference-deployment.mdx => reference-architecture.mdx} (66%) rename website/pages/docs/{ => architecture}/security-model.mdx (79%) diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 28eaf47dc4..bed4b0a5de 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -7,29 +7,31 @@ // serve as the category title in the sidebar export default [ - 'security-model', { category: 'architecture', - content: ['terminology', 'domain-model', 'reference-deployment'], - }, - { - category: 'domain-model', content: [ - 'actions', - 'auth-methods', - 'grants', - 'groups', - 'hosts', - 'host-catalogs', - 'host-sets', - 'organization', - 'principals', - 'projects', - 'resources', - 'scopes', - 'targets', - 'roles', - 'users', + 'security-model', + 'reference-architecture', + { + category: 'concepts', + content: [ + 'actions', + 'auth-methods', + 'grants', + 'groups', + 'hosts', + 'host-catalogs', + 'host-sets', + 'organization', + 'principals', + 'projects', + 'resources', + 'scopes', + 'targets', + 'roles', + 'users', + ], + }, ], }, { diff --git a/website/pages/docs/domain-model/actions.mdx b/website/pages/docs/architecture/concepts/actions.mdx similarity index 100% rename from website/pages/docs/domain-model/actions.mdx rename to website/pages/docs/architecture/concepts/actions.mdx diff --git a/website/pages/docs/domain-model/auth-methods.mdx b/website/pages/docs/architecture/concepts/auth-methods.mdx similarity index 100% rename from website/pages/docs/domain-model/auth-methods.mdx rename to website/pages/docs/architecture/concepts/auth-methods.mdx diff --git a/website/pages/docs/domain-model/grants.mdx b/website/pages/docs/architecture/concepts/grants.mdx similarity index 100% rename from website/pages/docs/domain-model/grants.mdx rename to website/pages/docs/architecture/concepts/grants.mdx diff --git a/website/pages/docs/domain-model/groups.mdx b/website/pages/docs/architecture/concepts/groups.mdx similarity index 100% rename from website/pages/docs/domain-model/groups.mdx rename to website/pages/docs/architecture/concepts/groups.mdx diff --git a/website/pages/docs/domain-model/host-catalogs.mdx b/website/pages/docs/architecture/concepts/host-catalogs.mdx similarity index 100% rename from website/pages/docs/domain-model/host-catalogs.mdx rename to website/pages/docs/architecture/concepts/host-catalogs.mdx diff --git a/website/pages/docs/domain-model/host-sets.mdx b/website/pages/docs/architecture/concepts/host-sets.mdx similarity index 100% rename from website/pages/docs/domain-model/host-sets.mdx rename to website/pages/docs/architecture/concepts/host-sets.mdx diff --git a/website/pages/docs/domain-model/hosts.mdx b/website/pages/docs/architecture/concepts/hosts.mdx similarity index 100% rename from website/pages/docs/domain-model/hosts.mdx rename to website/pages/docs/architecture/concepts/hosts.mdx diff --git a/website/pages/docs/domain-model/index.mdx b/website/pages/docs/architecture/concepts/index.mdx similarity index 100% rename from website/pages/docs/domain-model/index.mdx rename to website/pages/docs/architecture/concepts/index.mdx diff --git a/website/pages/docs/domain-model/organization.mdx b/website/pages/docs/architecture/concepts/organization.mdx similarity index 100% rename from website/pages/docs/domain-model/organization.mdx rename to website/pages/docs/architecture/concepts/organization.mdx diff --git a/website/pages/docs/domain-model/principals.mdx b/website/pages/docs/architecture/concepts/principals.mdx similarity index 100% rename from website/pages/docs/domain-model/principals.mdx rename to website/pages/docs/architecture/concepts/principals.mdx diff --git a/website/pages/docs/domain-model/projects.mdx b/website/pages/docs/architecture/concepts/projects.mdx similarity index 100% rename from website/pages/docs/domain-model/projects.mdx rename to website/pages/docs/architecture/concepts/projects.mdx diff --git a/website/pages/docs/domain-model/resources.mdx b/website/pages/docs/architecture/concepts/resources.mdx similarity index 100% rename from website/pages/docs/domain-model/resources.mdx rename to website/pages/docs/architecture/concepts/resources.mdx diff --git a/website/pages/docs/domain-model/roles.mdx b/website/pages/docs/architecture/concepts/roles.mdx similarity index 100% rename from website/pages/docs/domain-model/roles.mdx rename to website/pages/docs/architecture/concepts/roles.mdx diff --git a/website/pages/docs/domain-model/scopes.mdx b/website/pages/docs/architecture/concepts/scopes.mdx similarity index 100% rename from website/pages/docs/domain-model/scopes.mdx rename to website/pages/docs/architecture/concepts/scopes.mdx diff --git a/website/pages/docs/domain-model/targets.mdx b/website/pages/docs/architecture/concepts/targets.mdx similarity index 100% rename from website/pages/docs/domain-model/targets.mdx rename to website/pages/docs/architecture/concepts/targets.mdx diff --git a/website/pages/docs/domain-model/users.mdx b/website/pages/docs/architecture/concepts/users.mdx similarity index 100% rename from website/pages/docs/domain-model/users.mdx rename to website/pages/docs/architecture/concepts/users.mdx diff --git a/website/pages/docs/architecture/domain-model.mdx b/website/pages/docs/architecture/domain-model.mdx deleted file mode 100644 index 1f508de70b..0000000000 --- a/website/pages/docs/architecture/domain-model.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: docs -page_title: Architecture -sidebar_title: Domain Model -description: |- - Watchtower domain model ---- - -# Domain Model diff --git a/website/pages/docs/architecture/reference-deployment.mdx b/website/pages/docs/architecture/reference-architecture.mdx similarity index 66% rename from website/pages/docs/architecture/reference-deployment.mdx rename to website/pages/docs/architecture/reference-architecture.mdx index 7afa6c8f79..e38c683ba5 100644 --- a/website/pages/docs/architecture/reference-deployment.mdx +++ b/website/pages/docs/architecture/reference-architecture.mdx @@ -1,11 +1,11 @@ --- layout: docs page_title: Architecture -sidebar_title: Reference Deployment +sidebar_title: Reference Architecture description: |- - Watchtower reference deployment and considerations + Watchtower reference architecture and considerations --- # Overview -When deploying Watchtower in an on premise environment some considerations should be taken. The aim of this document is to provide minimum requirements for deploying Watchtower and a reference deployment model to follow in doing so. +When deploying Watchtower in an on premise environment some considerations should be taken. The aim of this document is to provide minimum requirements for deploying Watchtower and a reference architecture model to follow in doing so. diff --git a/website/pages/docs/security-model.mdx b/website/pages/docs/architecture/security-model.mdx similarity index 79% rename from website/pages/docs/security-model.mdx rename to website/pages/docs/architecture/security-model.mdx index 44ddd43885..65bfefedb6 100644 --- a/website/pages/docs/security-model.mdx +++ b/website/pages/docs/architecture/security-model.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Security Model +page_title: Architecture sidebar_title: Security Model description: |- Watchtower security model