docs: add docs site outline with placeholder files (#215)

2020-07-24 15:10:34 -07:00
1 parent 37d8f78091
commit 4fa8c5415b
@@ -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:
@@ -0,0 +1,3 @@
+{
+  "lockfileVersion": 1
+}
@@ -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' },
 ]
@@ -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]
@@ -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
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Architecture
+sidebar_title: Domain Model
+description: |-
+  Watchtower domain model
+---
+
+# Domain Model
@@ -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
@@ -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.
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Architecture
+sidebar_title: Terminology
+description: |-
+  Watchtower terminology
+---
+
+# Terminology
@@ -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]
@@ -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
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Authentication Methods
+description: |-
+  How to configure Watchtower authentication methods
+---
+
+# Authentication Methods
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Grants
+description: |-
+  How to configure Watchtower grants
+---
+
+# Grants
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Groups
+description: |-
+  How to configure Watchtower groups
+---
+
+# Groups
@@ -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.
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Projects
+description: |-
+  How to configure Watchtower projects
+---
+
+# Projects
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Roles
+description: |-
+  How to configure Watchtower roles
+---
+
+# Roles
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Configuration
+sidebar_title: Users
+description: |-
+  How to configure Watchtower users
+---
+
+# Users
@@ -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
-
-<EnterpriseAlert product="vault" />
-
-<Tabs>
-<Tab heading='Ruby'>
-
-Here's some tabbed content. Make sure to check out the other tab too!
-
-```ruby
-puts 'hello world'
-```
-
-</Tab>
-<Tab heading='Javascript'>
-
-Hi I'm the other tab, nice to meet you!
-
-```js
-console.log('hello world')
-```
-
-</Tab>
-</Tabs>
@@ -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
-
-<EnterpriseAlert />
-
-### Tabs
+### Clients

 <Tabs>
-<Tab heading='Tab 1'>

-Content for Tab 1
+<Tab heading="Command Line">Command line reference overview</Tab>

+<Tab heading="Admin Console">
+Reference documentation for the administrative console
 </Tab>
-<Tab heading='Tab 2'>
-
-Content for Tab 2
-
+  
+<Tab heading="Terraform Provider">
+[Link to provider documentation]
 </Tab>
 </Tabs>
+
+### SDK
+
+[Link to godoc site]
@@ -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.
@@ -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.
@@ -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.
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: SDK
+sidebar_title: Login/Logout
+description: |-
+  Watchtower SDK login and logout
+---
+
+# How to Login and Logout
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Security Model
+sidebar_title: Security Model
+description: |-
+  Watchtower security model
+---
+
+# Overview