diff --git a/Makefile b/Makefile index dfbcfe0a0..44365844d 100644 --- a/Makefile +++ b/Makefile @@ -84,6 +84,16 @@ protobuild: protolint: @buf check lint -.PHONY: api tools gen migrations proto +# must have nodejs and npm installed +website: website-install website-start + +website-install: + @npm install --prefix website/ + +website-start: + @npm start --prefix website/ + + +.PHONY: api tools gen migrations proto website .NOTPARALLEL: diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..48e341a09 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,3 @@ +{ + "lockfileVersion": 1 +} diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index d30d26b4a..a6ce4ad07 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -7,11 +7,28 @@ // serve as the category title in the sidebar export default [ - 'example', + 'security-model', { - category: 'nested', - content: ['nested-example'], + category: 'architecture', + content: ['terminology', 'domain-model', 'reference-deployment'], }, + { + category: 'configuration', + content: ['auth-methods', 'projects', 'users', 'groups', 'roles', 'grants'], + }, + { + category: 'command-line', + content: ['login'], + }, + { + category: 'admin-console', + content: ['login'], + }, + { + category: 'sdk', + content: ['login'], + }, + '---', { title: 'External Link', href: 'https://www.hashicorp.com' }, ] diff --git a/website/pages/docs/admin-console/index.mdx b/website/pages/docs/admin-console/index.mdx new file mode 100644 index 000000000..55eb8ec63 --- /dev/null +++ b/website/pages/docs/admin-console/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Admin Console Index +sidebar_title: Admin Console +description: |- + Reference documentation for the administrative console for Watchtower +--- + +# Administrative Console Overview + +[TBD] diff --git a/website/pages/docs/admin-console/login.mdx b/website/pages/docs/admin-console/login.mdx new file mode 100644 index 000000000..b5ce310ee --- /dev/null +++ b/website/pages/docs/admin-console/login.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Admin Console +sidebar_title: Login/Logout +description: |- + Watchtower admin console login and logout +--- + +# How to Login and Logout diff --git a/website/pages/docs/architecture/domain-model.mdx b/website/pages/docs/architecture/domain-model.mdx new file mode 100644 index 000000000..1f508de70 --- /dev/null +++ b/website/pages/docs/architecture/domain-model.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Architecture +sidebar_title: Domain Model +description: |- + Watchtower domain model +--- + +# Domain Model diff --git a/website/pages/docs/architecture/index.mdx b/website/pages/docs/architecture/index.mdx new file mode 100644 index 000000000..b4b94c8f4 --- /dev/null +++ b/website/pages/docs/architecture/index.mdx @@ -0,0 +1,9 @@ +--- +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/reference-deployment.mdx b/website/pages/docs/architecture/reference-deployment.mdx new file mode 100644 index 000000000..7afa6c8f7 --- /dev/null +++ b/website/pages/docs/architecture/reference-deployment.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Architecture +sidebar_title: Reference Deployment +description: |- + Watchtower reference deployment 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. diff --git a/website/pages/docs/architecture/terminology.mdx b/website/pages/docs/architecture/terminology.mdx new file mode 100644 index 000000000..59792c24b --- /dev/null +++ b/website/pages/docs/architecture/terminology.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Architecture +sidebar_title: Terminology +description: |- + Watchtower terminology +--- + +# Terminology diff --git a/website/pages/docs/command-line/index.mdx b/website/pages/docs/command-line/index.mdx new file mode 100644 index 000000000..2f4f2971b --- /dev/null +++ b/website/pages/docs/command-line/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Command Line Index +sidebar_title: Command Line +description: |- + Reference documentation for the Watchtower command line +--- + +# Command Line Overview + +[TBD] diff --git a/website/pages/docs/command-line/login.mdx b/website/pages/docs/command-line/login.mdx new file mode 100644 index 000000000..e57db3943 --- /dev/null +++ b/website/pages/docs/command-line/login.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Command Line +sidebar_title: Login/Logout +description: |- + Watchtower command line login and logout +--- + +# How to Login and Logout diff --git a/website/pages/docs/configuration/auth-methods.mdx b/website/pages/docs/configuration/auth-methods.mdx new file mode 100644 index 000000000..462d2e695 --- /dev/null +++ b/website/pages/docs/configuration/auth-methods.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Authentication Methods +description: |- + How to configure Watchtower authentication methods +--- + +# Authentication Methods diff --git a/website/pages/docs/configuration/grants.mdx b/website/pages/docs/configuration/grants.mdx new file mode 100644 index 000000000..ffb49cc05 --- /dev/null +++ b/website/pages/docs/configuration/grants.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Grants +description: |- + How to configure Watchtower grants +--- + +# Grants diff --git a/website/pages/docs/configuration/groups.mdx b/website/pages/docs/configuration/groups.mdx new file mode 100644 index 000000000..a551a130d --- /dev/null +++ b/website/pages/docs/configuration/groups.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Groups +description: |- + How to configure Watchtower groups +--- + +# Groups diff --git a/website/pages/docs/configuration/index.mdx b/website/pages/docs/configuration/index.mdx new file mode 100644 index 000000000..34c91b335 --- /dev/null +++ b/website/pages/docs/configuration/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: Configuration Index +sidebar_title: Configuration +description: |- + Reference documentation for configuring Watchtower +--- + +# Overview + +Users can configure Watchtower via command line, admin console, terraform, or the SDK. This section covers what configuration resources are avaialble, and how they're releated. For details on using a specific method, please see that method's specific documentation. diff --git a/website/pages/docs/configuration/projects.mdx b/website/pages/docs/configuration/projects.mdx new file mode 100644 index 000000000..5f4c635fa --- /dev/null +++ b/website/pages/docs/configuration/projects.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Projects +description: |- + How to configure Watchtower projects +--- + +# Projects diff --git a/website/pages/docs/configuration/roles.mdx b/website/pages/docs/configuration/roles.mdx new file mode 100644 index 000000000..933089f1e --- /dev/null +++ b/website/pages/docs/configuration/roles.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Roles +description: |- + How to configure Watchtower roles +--- + +# Roles diff --git a/website/pages/docs/configuration/users.mdx b/website/pages/docs/configuration/users.mdx new file mode 100644 index 000000000..a353b5642 --- /dev/null +++ b/website/pages/docs/configuration/users.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Configuration +sidebar_title: Users +description: |- + How to configure Watchtower users +--- + +# Users diff --git a/website/pages/docs/example.mdx b/website/pages/docs/example.mdx deleted file mode 100644 index 4aba5ae93..000000000 --- a/website/pages/docs/example.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: docs -page_title: Markdown Examples -sidebar_title: Examples -description: |- - Write a description here, this appears in search engines and social shares ---- - -# Example Page - -This is an example of a typical documentation page. Below are demos of various markdown features that are available to docs authors. - -### Code Blocks - -```shell-session -$ echo 'shell example' -``` - -```hcl -# These control access to the key/value store. -key_prefix "" { - policy = "read" -} -``` - -### Includes - -@include 'example.mdx' - -### Anchor Links ((#anchors)) - -- the following syntax can be used for anchor link aliases: ((#foo)) -- `foo` ((#bar)) - lists that begin with inline code get anchor links -- normal list items do not though - -### Alerts - -=> This is a **success** alert - --> This is an **info** alert - -~> This is a **warning** alert - -!> This is a **danger** alert - -### Custom MDX Components - - - - - - -Here's some tabbed content. Make sure to check out the other tab too! - -```ruby -puts 'hello world' -``` - - - - -Hi I'm the other tab, nice to meet you! - -```js -console.log('hello world') -``` - - - diff --git a/website/pages/docs/index.mdx b/website/pages/docs/index.mdx index 9faa22db2..81ce9e99b 100644 --- a/website/pages/docs/index.mdx +++ b/website/pages/docs/index.mdx @@ -2,29 +2,29 @@ layout: docs page_title: Documentation sidebar_title: Overview -description: |- - Write a description here, this appears in search engines and social shares +description: Watchtower reference documentation --- -# Example Documentation +# Watchtower Reference Documentation +Watchtower reference documentation covers Watchtower architecture and supported clients. This is typically a generic introduction page to the documentation. Below is a showcase of some of the custom components that are available within documentation pages. -### Enterprise Alert - - - -### Tabs +### Clients - -Content for Tab 1 +Command line reference overview + +Reference documentation for the administrative console - - -Content for Tab 2 - + + +[Link to provider documentation] + +### SDK + +[Link to godoc site] diff --git a/website/pages/docs/nested/index.mdx b/website/pages/docs/nested/index.mdx deleted file mode 100644 index c3a36e4aa..000000000 --- a/website/pages/docs/nested/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: docs -page_title: Nested Content Index -sidebar_title: Nested Content -description: |- - Write a description here, this appears in search engines and social shares ---- - -# Example Page - -This is an example of a typical documentation page, nested within a folder. This is an index, or "overview" page. diff --git a/website/pages/docs/nested/nested-example.mdx b/website/pages/docs/nested/nested-example.mdx deleted file mode 100644 index eb82b67af..000000000 --- a/website/pages/docs/nested/nested-example.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: docs -page_title: Nested Content -sidebar_title: Nested Page -description: |- - Write a description here, this appears in search engines and social shares ---- - -# Example Page - -This is an example of a typical documentation page, nested within a folder. diff --git a/website/pages/docs/sdk/index.mdx b/website/pages/docs/sdk/index.mdx new file mode 100644 index 000000000..00575fd75 --- /dev/null +++ b/website/pages/docs/sdk/index.mdx @@ -0,0 +1,11 @@ +--- +layout: docs +page_title: SDK Index +sidebar_title: SDK +description: |- + Reference documentation for the Watchtower SDK +--- + +# Overview + +Detailed SDK documentation can be found on the (godoc)[] site. This documentation covers basic examples for common SDK use cases. diff --git a/website/pages/docs/sdk/login.mdx b/website/pages/docs/sdk/login.mdx new file mode 100644 index 000000000..f34102058 --- /dev/null +++ b/website/pages/docs/sdk/login.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: SDK +sidebar_title: Login/Logout +description: |- + Watchtower SDK login and logout +--- + +# How to Login and Logout diff --git a/website/pages/docs/security-model.mdx b/website/pages/docs/security-model.mdx new file mode 100644 index 000000000..44ddd4388 --- /dev/null +++ b/website/pages/docs/security-model.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Security Model +sidebar_title: Security Model +description: |- + Watchtower security model +--- + +# Overview