Merge pull request #560 from rkvst/structure-update-collab

RKVST docs structure refresh.

README.md

@@ -2,11 +2,11 @@
 
 This is the Home of the RKVST Documentation.
 
-RKVST provides Continuous Assurance as a Service to attest trustworthiness of Assets and boost confidence in critical decisions.  Find out more on our [website](https://rkvst.com).
+RKVST provides Provenance as a Service to attest trustworthiness of Assets and boost confidence in digital decisions.  Find out more on our [website](https://rkvst.com).
 
 ## Contributing
 
-To contribute to these Docs, please refer to our [Contributing Guidelines](https://docs.rkvst.com/contributing/getting-started/pulling-and-building-rkvst-docs/).
+To contribute to these Docs, please refer to our [Contributing Guidelines](/contributing/getting-started/pulling-and-building-rkvst-docs/).
 
 We'll happily review any suggestions!
 

archetypes/developers.md

@@ -0,0 +1,16 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+description: ""
+lead: ""
+date: {{ .Date }}
+lastmod: {{ .Date }}
+draft: false
+images: []
+menu: 
+  developers:
+    parent: ""
+weight: 999
+toc: true
+---
+
+{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}}

archetypes/glossary.md

@@ -0,0 +1,16 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+description: ""
+lead: ""
+date: {{ .Date }}
+lastmod: {{ .Date }}
+draft: false
+images: []
+menu: 
+  glossary:
+    parent: ""
+weight: 999
+toc: true
+---
+
+{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}}

archetypes/docs.md → archetypes/platform.md

@@ -4,10 +4,10 @@ description: ""
 lead: ""
 date: {{ .Date }}
 lastmod: {{ .Date }}
-draft: true
+draft: false
 images: []
 menu: 
-  docs:
+  platform:
     parent: ""
 weight: 999
 toc: true

archetypes/usecases.md

@@ -0,0 +1,16 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+description: ""
+lead: ""
+date: {{ .Date }}
+lastmod: {{ .Date }}
+draft: false
+images: []
+menu: 
+  usecases:
+    parent: ""
+weight: 999
+toc: true
+---
+
+{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}}

assets/js/index.js

@@ -77,7 +77,7 @@ Source:
   });
 
   var docs = [
-    {{ range $index, $page := (where .Site.Pages "Section" "docs") -}}
+    {{ range $index, $page := (where .Site.Pages "Section" "developers") -}}
       {
         id: {{ $index }},
         href: "{{ .Permalink }}",
@@ -89,7 +89,7 @@ Source:
   ];
 
 
-  {{ $list := (where .Site.Pages "Section" "docs") -}}
+  {{ $list := (where .Site.Pages "Section" "developers") -}}
   {{ $len := (len $list) -}}
 
   index.add(

assets/scss/common/_variables.scss

@@ -133,6 +133,7 @@ $headings-font-family:        null;
 $headings-font-weight:        700;
 
 $lead-font-weight:            400;
+$sublead-font-weight:         300;
 
 // Spacing
 //

config/_default/menus.toml

@@ -21,69 +21,86 @@
   weight = 1
   identifier = "getting-started"
   url = "/contributing/getting-started/"
-
-[[docs]]
+
+
+
+[[developers]]
+  name = "Developer Patterns"
+  weight = 10
+  identifier = "developer-patterns"
+  url = "/developers/developer-patterns/"
+
+[[developers]]
   name = "API Reference"
-  weight = 50
+  weight = 20
   identifier = "api-reference"
-  url = "/docs/api-reference/"
+  url = "/developers/api-reference/"
 
-[[docs]]
+[[developers]]
   name = "YAML Runner Reference"
-  weight = 51
+  weight = 30
   identifier = "yaml-reference"
-  url = "/docs/yaml-reference/"
+  url = "/developers/yaml-reference/"
 
-[[docs]]
-  name = "User Patterns"
-  weight = 2
-  identifier = "user-patterns"
-  url = "/docs/user-patterns/"
 
-[[docs]]
-  name = "Developer Patterns"
-  weight = 3
-  identifier = "developer-patterns"
-  url = "/docs/developer-patterns/"
 
-[[docs]]
-  name = "Beyond the Basics"
-  weight = 5
-  identifier = "beyond-the-basics"
-  url = "/docs/beyond-the-basics/"
+[[platform]]
+  name = "Overview"
+  weight = 10
+  identifier = "overview"
+  url = "/platform/overview/"
+
+[[platform]]
+  name = "Administration"
+  weight = 20
+  identifier = "administration"
+  url = "/platform/administration/"
+
+
+
+[[usecases]]
+  name = "Use Cases & Examples"
+  weight = 40
+  identifier = "usecases"
+  url = "/platform/usecases/"
 
-[[docs]]
-  name = "RKVST Basics"
-  weight = 4
-  identifier = "rkvst-basics"
-  url = "/docs/rkvst-basics/"
 
-[[docs]]
+
+[[glossary]]
   name = "Glossary"
-  weight = 6
+  weight = 50
   identifier = "glossary"
-  url = "/docs/glossary/"
+  url = "/glossary/"
+
 
-[[docs]]
-  name = "Overview"
-  weight = 1
-  identifier = "overview"
-  url = "/docs/overview/"
 
 [[main]]
-  name = "Contributing"
-  url = "/contributing/getting-started/pulling-and-building-rkvst-docs"
+  name = "Home"
+  url = "/"
+  weight = 10
+
+[[main]]
+  name = "Developers"
+  url = "/developers/developer-patterns/containers-as-assets/"
+  weight = 20
+
+[[main]]
+  name = "Platform"
+  url = "/platform/overview/introduction"
   weight = 30
 
 [[main]]
   name = "Support"
   url = "https://support.rkvst.com"
-  weight = 20
+  weight = 40
 
 [[main]]
-  name = "Docs"
-  url = "/docs/overview/introduction"
-  weight = 10
+  name = "Contributing"
+  url = "/contributing/getting-started/pulling-and-building-rkvst-docs"
+  weight = 50
+
+
+
 
 [[social]]
   name = "Twitter"
@@ -94,7 +111,7 @@
 [[social]]
   name = "GitHub"
   pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
-  url = "https://github.com/rkvst/rkvst-docs"
+  url = "https://github.com/rkvst/"
   post = "v0.1.0"
   weight = 20
 

config/_default/params.toml

@@ -3,8 +3,8 @@
 ## Homepage
 title = "RKVST"
 titleSeparator = "-"
-titleAddition = "Continuous Assurance to boost confidence in critical decisions."
-description = "RKVST provides Continuous Assurance as a Service to attest trustworthiness of assets, and boost confidence in critical decisions.  Find out more on our [website](https://rkvst.com)."
+titleAddition = "Provenance as a Service to boost confidence in digital decisions."
+description = "RKVST provides Provenance as a Service to attest trustworthiness of assets, and boost confidence in digital decisions.  Find out more on our [website](https://rkvst.com)."
 
 ## Open Graph + Twitter Cards
 images = ["RKVST_WhtLogo_CMYK.svg"]

content/_index.md

@@ -1,7 +1,8 @@
 ---
 title : "RKVST"
-description: "RKVST provides Continuous Assurance as a Service to attest trustworthiness of assets, and boost confidence in critical decisions.  Find out more on our [website](https://rkvst.com)."
-lead: "Continuous Assurance to boost confidence in critical decisions."
+description: "RKVST provides Provenance as a Service to attest trustworthiness of assets, and boost confidence in digital decisions.  Find out more on our [website](https://rkvst.com)."
+lead: "Data provenance with a simple API."
+sublead: "Prove and verify the provenance and authenticity of any data, anywhere."
 date: 2020-10-06T08:47:36+00:00
 lastmod: 2020-10-06T08:47:36+00:00
 draft: false

content/contributing/formatting-content/style-guide/index.md

@@ -70,7 +70,7 @@ The documentation is primarily written in `Articles`, individual bodies of text,
 At a directory level this looks like this:
 
 ```bash
-./content/docs/overview/when-who-did-what-to-a-thing/index.md
+./content/platform/overview/when-who-did-what-to-a-thing/index.md
 ```
 
 Where under the root content folder we can see the `docs` area, followed by the `overview` section, containing the article `when-who-did-what-to-a-thing`.

content/developers/_index.md

@@ -0,0 +1,9 @@
+---
+title : "Developers"
+description: "RKVST developer documentation"
+date: 2020-10-06T08:48:23+00:00
+lastmod: 2020-10-06T08:48:23+00:00
+draft: false
+images: []
+---
+Information for developers can be found here:

content/docs/glossary/_index.md → content/developers/api-reference/_index.md

@@ -1,11 +1,13 @@
 ---
-title: "glossary"
+title: "API Reference"
 description: ""
 lead: ""
 date: 2021-06-09T10:19:37+01:00
 lastmod: 2021-06-09T10:19:37+01:00
 draft: false
 images: []
-weight: 999
-toc: false
----
+weight: 998
+toc: true
+---
+Select an API endpoint for more information.
+

content/docs/api-reference/app-registrations-api/index.md → content/developers/api-reference/app-registrations-api/index.md

@@ -7,7 +7,7 @@ lastmod: 2021-06-09T11:39:03+01:00
 draft: false
 images: []
 menu: 
-  docs:
+  developers:
     parent: "api-reference"
 weight: 101
 toc: true
@@ -28,7 +28,7 @@ To provide your credentials with access to the Assets and Events in your Tenancy
 If you wish to give your credentials Administrator priviliges to access everything in your Tenancy, you would use the `client-id` as the subject and `https://app.rkvst.io/appidpv1` as the issuer in the `Settings` screen or by using the [Administrators Endpoint in the Tenancies API](../tenancies-api/).
 
 {{< note >}}
-For more information on App Registrations and access tokens, visit [RKVST Basics](https://docs.rkvst.com/docs/rkvst-basics/getting-access-tokens-using-app-registrations/).
+For more information on App Registrations and access tokens, visit [RKVST Developer Patterns](/developers/developer-patterns/getting-access-tokens-using-app-registrations/).
 {{< /note >}}
 
 ### Creating an Application

content/docs/api-reference/assets-api/index.md → content/developers/api-reference/assets-api/index.md

@@ -7,19 +7,19 @@ lastmod: 2021-06-09T11:39:03+01:00
 draft: false
 images: []
 menu: 
-  docs:
+  developers:
     parent: "api-reference"
 weight: 102
 toc: true
 ---
 
 {{< note >}}
-For more information on Assets and Asset creation, visit our [Core Concepts](https://docs.rkvst.com/docs/overview/core-concepts/#assets) and [Creating an Asset](https://docs.rkvst.com/docs/rkvst-basics/creating-an-asset/) guide.
+For more information on Assets and Asset creation, visit our [Core Concepts](/platform/overview/core-concepts/#assets) and [Creating an Asset](/platform/overview/creating-an-asset/) guide.
 {{< /note >}}
 
 ## Asset API Examples
 
-Create the [bearer_token](../../setup-and-administration/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
+Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
 
 ### Asset Record Creation
 
@@ -93,7 +93,7 @@ The response is:
 **Warning**: Assets can only be made public at Asset creation and cannot be made private afterwards.
 {{< /warning >}}
 
-In most cases it is appropriate to create a standard Asset. These Assets can only be shared externally using Access Policies as described in [Sharing Assets with OBAC](../../rkvst-basics/sharing-assets-with-obac/) or the [IAM Policies API Reference](../iam-policies-api/).
+In most cases it is appropriate to create a standard Asset. These Assets can only be shared externally using Access Policies as described in [Sharing Assets with OBAC](/platform/administration/sharing-assets-with-obac/) or the [IAM Policies API Reference](../iam-policies-api/).
 
 However, it is also possible to create a Public Asset which can be shared with a read-only public url; similar to the link sharing you may have seen in file sharing services like Google Drive or DropBox.
 

content/docs/api-reference/attachments-api/index.md → content/developers/api-reference/attachments-api/index.md

@@ -7,17 +7,17 @@ lastmod: 2021-06-09T12:05:02+01:00
 draft: false
 images: []
 menu: 
-  docs:
+  developers:
     parent: "api-reference"
 weight: 103
 toc: true
 ---
 
 ## Attachment API Examples
 
-The Attachments API enables you to query Binary Large OBjects (BLOBs) such as documents, process artifacts and images that are attached to your evidence ledger. For details of how to actually attach these BLOBs to Events and Assets, see the [the Events API Reference](../../api-reference/events-api/#adding-attachments).
+The Attachments API enables you to query Binary Large OBjects (BLOBs) such as documents, process artifacts and images that are attached to your evidence ledger. For details of how to actually attach these BLOBs to Events and Assets, see the [the Events API Reference](../events-api/#adding-attachments).
 
-Create the [bearer_token](../../setup-and-administration/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
+Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
 
 ### Retrieve a Specific Attachment on an Asset
 

content/docs/api-reference/blobs-api/index.md → content/developers/api-reference/blobs-api/index.md

@@ -7,7 +7,7 @@ lastmod: 2021-06-09T13:32:57+01:00
 draft: false
 images: []
 menu: 
-  docs:
+  developers:
     parent: "api-reference"
 weight: 104
 toc: true
@@ -18,10 +18,10 @@ toc: true
 The Blobs API enables you to upload Binary Large OBjects (BLOBs) such as documents, process artifacts and images to attach to your evidence ledger. 
 
 {{< note >}}
-**Note:** Blobs cannot be searched or listed as a collection in their own right: they must always be associated with an Asset or Event through an Attachment Attribute and can only be downloaded by users with appropriate access rights to that Attachment. For information on Attachments and how to implement them, please refer to [the Events API Reference](../../api-reference/events-api/#adding-attachments).
+**Note:** Blobs cannot be searched or listed as a collection in their own right: they must always be associated with an Asset or Event through an Attachment Attribute and can only be downloaded by users with appropriate access rights to that Attachment. For information on Attachments and how to implement them, please refer to [the Events API Reference](../events-api/#adding-attachments).
 {{< /note >}}
 
-Create the [bearer_token](../../setup-and-administration/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
+Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
 
 ### Upload a Blob