Merge pull request #610 from rkvst/index-sub-trees

Improved navigation breadcrumb pages
datatrails · Jul 20, 2023 · 5cb9ce8 · 5cb9ce8
2 parents dd514bd + 3c2d2cf
commit 5cb9ce8
Show file tree

Hide file tree

Showing 15 changed files with 209 additions and 68 deletions.
diff --git a/config/_default/menus.toml b/config/_default/menus.toml
@@ -81,23 +81,33 @@
 
 [[main]]
   name = "Developers"
-  url = "/developers/developer-patterns/containers-as-assets/"
+  url = "/developers/"
   weight = 20
 
 [[main]]
   name = "Platform"
-  url = "/platform/overview/introduction"
+  url = "/platform/"
   weight = 30
 
+[[main]]
+  name = "Use Cases"
+  url = "/usecases/"
+  weight = 40
+
+[[main]]
+  name = "Glossary"
+  url = "/glossary/"
+  weight = 50
+
 [[main]]
   name = "Support"
   url = "https://support.rkvst.com"
-  weight = 40
+  weight = 60
 
 [[main]]
   name = "Contributing"
   url = "/contributing/getting-started/pulling-and-building-rkvst-docs"
-  weight = 50
+  weight = 70
 
 
 

diff --git a/content/developers/_index.md b/content/developers/_index.md
@@ -8,4 +8,52 @@ images: []
 aliases:
     - /docs/developers/
 ---
-Information for developers can be found here:
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+    <h1>Developers</h1>
+    <p>If you are a developer who is looking to easily add provenance to their data, this section is for you. <br>
+    You may be building a new application or looking for a way to add functionality to something that you already use every day.</p>
+    <p>The RKVST REST API, python SDK, or the YAML runner provide a simple way for you to integrate a provenance layer into your existing data platform so that you do not need to change the way that your users work.</p>
+    <p> Check out the sub-sections below for more information!</p>
+    </div>
+</div>
+
+<section class="section section-sm" style="padding-top: 20px; padding-bottom: 50px;">
+  <div class="container">
+    <div class="row justify-content-center text-center">
+      <div class="col-xs-9 col-sm-11 col-lg-4">
+        <div class="card" style="max-width: 25rem;">
+          <div class="card-body">
+            <h5 class="card-title">Developer Patterns</h5>
+             <p class="card-text">Go here for information on setting up an App Registration, requesting an Access Token together with other developer concepts and user profile descriptions.</p>
+             <a href="/developers/developer-patterns/getting-access-tokens-using-app-registrations" class="btn btn-primary">Go to Patterns</a>
+          </div>
+        </div>
+      </div>
+      <div class="col-xs-9 col-sm-11 col-lg-4">
+      	<div class="card" style="max-width: 25rem;">
+          <div class="card-body">
+            <h5 class="card-title">API Reference</h5>
+            <p class="card-text">The RKVST REST API endpoint examples and definitions can be found here. The <a href="https://app.rkvst.io" target="_blank">RKVST Web interface</a> also contains an interactive Swagger reference for developers.</p>
+            <a href="/developers/api-reference/app-registrations-api" class="btn btn-primary">Go to API</a>
+          </div>
+      	</div>
+      </div>      
+      <div class=" col-xs-9 col-sm-11 col-lg-4">
+        <div class="card" style="max-width: 25rem;">
+          <div class="card-body">
+            <h5 class="card-title">YAML Runner Reference</h5>
+            <p class="card-text">The YAML reference contains information and examples for those who work with YAML files and would prefer to use this method to access the API.</p><br>
+            <a href="/developers/yaml-reference/story-runner-components" class="btn btn-primary">Go to YAML</a>
+          </div>
+        </div>
+      </div>      
+    </div>
+  </div>
+</section>
+
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+        <p>Additional resources are available from our <a href="https://pypi.org/project/rkvst-archivist/" target="_blank">Python SDK</a> and the <a href="https://github.com/rkvst/rkvst-samples" target="_blank">Python Samples</a>.</p>
+    </div>
+</div>
diff --git a/content/developers/api-reference/_index.md b/content/developers/api-reference/_index.md
@@ -6,10 +6,29 @@ date: 2021-06-09T10:19:37+01:00
 lastmod: 2021-06-09T10:19:37+01:00
 draft: false
 images: []
-weight: 998
 toc: true
 aliases:
     - /docs/api-reference/
 ---
-Select an API endpoint for more information.
-
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+      <h1>API Reference</h1>
+      <p>This sub-section of the Developers subject area contains articles that describe and define the RKVST REST API endpoints.<br></p>
+      <p> Check out the articles below for more information!</p><br>
+      <p><a href="/developers/api-reference/app-registrations-api/">App Registrations API Registrations &rarr;</a><br>
+      <a href="/developers/api-reference/assets-api/">Assets API &rarr;</a><br>
+      <a href="/developers/api-reference/attachments-api/">Attachments API &rarr;</a><br>
+      <a href="/developers/api-reference/blobs-api/">Blobs API &rarr;</a><br>
+      <a href="/developers/api-reference/blockchain-api/">Blockchain API (v1alpha2) &rarr;</a><br>
+      <a href="/developers/api-reference/compliance-api/">Compliance API &rarr;</a><br>
+      <a href="/developers/api-reference/events-api/">Events API &rarr;</a><br>
+      <a href="/developers/api-reference/iam-policies-api/">IAM Policies API &rarr;</a><br>
+      <a href="/developers/api-reference/iam-subjects-api/">IAM Subjects API &rarr;</a><br>
+      <a href="/developers/api-reference/invites-api/">Invites API &rarr;</a><br>
+      <a href="/developers/api-reference/locations-api/">Locations API &rarr;</a><br>
+      <a href="/developers/api-reference/public-assets-api/">Public Assets API &rarr;</a><br>
+      <a href="/developers/api-reference/system-api/">System API &rarr;</a><br>
+      <a href="/developers/api-reference/tenancies-api/">Tenancies API &rarr;</a><br>
+      <a href="/developers/api-reference/tls-ca-certificates-api/">TLS CA Certificates API &rarr;</a></p>
+    </div>
+</div>
diff --git a/content/developers/developer-patterns/_index.md b/content/developers/developer-patterns/_index.md
@@ -11,4 +11,17 @@ toc: true
 aliases: 
   - /docs/developer-patterns/
 ---
-Some common developer use cases are described in the options below:
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+      <h1>Developer Patterns</h1>
+      <p>This sub-section of the Developers subject area contains more detailed information on topics that cannot be covered by the API or YAML Runner references. <br></p>
+      <p>You will find articles on common developer tasks and concept guides that are relevant to developers.</p>
+      <p> Check out the articles below for more information!</p><br>
+      <p><a href="/developers/developer-patterns/getting-access-tokens-using-app-registrations/">Getting Access Tokens using App Registrations &rarr;</a><br>
+      <a href="/developers/developer-patterns/containers-as-assets/">Containers as Assets &rarr;</a><br>
+      <a href="/developers/developer-patterns/namespace/">Namespace &rarr;</a><br>
+      <a href="/developers/developer-patterns/verifying-with-simple-hash/">Verifying Assets and Events with Simple Hash &rarr;</a><br>
+      <a href="/developers/developer-patterns/document-profile/">Document Profile &rarr;</a><br>
+      <a href="/developers/developer-patterns/software-package-profile/">Software Package Profile &rarr;</a></p>
+    </div>
+</div>
diff --git a/content/developers/yaml-reference/_index.md b/content/developers/yaml-reference/_index.md
@@ -11,4 +11,17 @@ toc: true
 aliases: 
   - /docs/yaml-reference/
 ---
-Need some introductory developer content here
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+      <h1>YAML Runner Reference</h1>
+      <p>This sub-section of the Developers subject area contains articles that describe and define the functionality of the RKVST YAML Runner.<br></p>
+      <p> Check out the articles below for more information!</p><br>
+      <p><a href="/developers/yaml-reference/story-runner-components/">YAML Runner Components &rarr;</a><br>
+      <a href="/developers/yaml-reference/assets/">Assets YAML Runner &rarr;</a><br>
+      <a href="/developers/yaml-reference/events/">Events YAML Runner &rarr;</a><br>
+      <a href="/developers/yaml-reference/locations/">Locations YAML Runner &rarr;</a><br>
+      <a href="/developers/yaml-reference/subjects/">Subjects YAML Runner &rarr;</a><br>
+      <a href="/developers/yaml-reference/compliance/">Compliance Policies YAML Runner &rarr;</a><br>
+      <a href="/developers/yaml-reference/estate-info/">Estate Information YAML Runner &rarr;</a></p>
+    </div>
+</div>
diff --git a/content/glossary/_index.md b/content/glossary/_index.md
@@ -11,4 +11,11 @@ toc: true
 aliases: 
   - /docs/glossary/
 ---
-Select an option to to find out more about the terms used by RKVST.
+Select an option to to find out more about the terms used by RKVST.
+
+* Common RKVST Terms: A list of terms used by RKVST.
+* Reserved Attributes: A list of Asset attributes that are used by the RKVST platform and have a specific purpose.
+
+
+
+
diff --git a/content/platform/_index.md b/content/platform/_index.md
@@ -10,4 +10,36 @@ aliases:
   - /docs/beyond-the-basics/
 ---
 
-Select an option to find out more about the RKVST platform.
+<div class= "row justify-content-center">
+  <div class="col-md-12 col-lg-10 col-xl-10">
+    <h1>Platform</h1>
+    <p>If you are new to RKVST, this is the place to start.<br></p>
+    <p>The foundations of understanding the RKVST platform are laid in the Overview. This will introduce the basic (and not so basic) concepts and take you through creating your first Asset and registering an Event.</p>
+    <p>The Administration section will show you how to manage your Tenancy and control access to your Assets.
+    <p> Check out the sub-sections below for more information!</p>
+    <section class="section section-sm" style="padding-top: 20px; padding-bottom: 50px;">
+      <div class="container">
+        <div class="row justify-content-left text-center">
+          <div class="col-xs-9 col-sm-11 col-lg-6">
+            <div class="card" style="max-width: 25rem;">
+              <div class="card-body">
+                <h5 class="card-title">Overview</h5>
+                 <p class="card-text">Core concepts and tasks.</p><br>
+                 <a href="/platform/overview/introduction/" class="btn btn-primary">Overview</a>
+              </div>
+            </div>
+          </div>
+          <div class="col-xs-9 col-sm-11 col-lg-6">
+        	  <div class="card" style="max-width: 25rem;">
+              <div class="card-body">
+               <h5 class="card-title">Administration</h5>
+                <p class="card-text">Create users, set access rights and share Assets.</p>
+                <a href="/platform/administration/identity-and-access-management/" class="btn btn-primary">Administration</a>
+              </div>
+          	</div>
+          </div>          
+        </div>
+      </div>
+    </section>
+  </div>
+</div>
diff --git a/content/platform/administration/_index.md b/content/platform/administration/_index.md
@@ -9,4 +9,16 @@ images: []
 weight: 999
 toc: true
 ---
-These topics contain information on the administration tasks for your RKVST tenancy.
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+      <h1>Administration</h1>
+      <p>This section is for Tenancy Administrators who need to know how to manage their Users and configure access to Assets.<br></p>
+      <p> Check out the articles below for more information!</p><br>
+      <p><a href="/platform/administration/identity-and-access-management/">Identity and Access Management &rarr;</a><br>
+      <a href="/platform/administration/verified-domain/">Verified Domain &rarr;</a><br>
+      <a href="/platform/administration/managing-access-to-an-asset-with-abac/">Managing Access to an Asset With ABAC &rarr;</a><br>
+      <a href="/platform/administration/sharing-assets-outside-your-tenant/">Sharing Assets outside your Tenant &rarr;</a><br>
+      <a href="/platform/administration/compliance-policies/">Compliance Policies &rarr;</a><br>
+      <a href="/platform/administration/grouping-assets-by-location/">Grouping Assets by Location &rarr;</a></p>
+    </div>
+</div>
diff --git a/content/platform/overview/_index.md b/content/platform/overview/_index.md
@@ -9,5 +9,19 @@ toc: true
 aliases:
     - /docs/overview/
 ---
-
-The topics below provide an introduction to RKVST concepts.
+<div class= "row justify-content-center">
+    <div class="col-md-12 col-lg-10 col-xl-10">
+      <h1>Overview</h1>
+      <p>Begin your RKVST journey here.<br></p>
+      <p> Check out the articles below for an introduction to the RKVST platform.</p><br>
+      <p><a href="/platform/overview/introduction/">Introduction &rarr;</a><br>
+      <a href="/platform/overview/core-concepts/">Core Concepts &rarr;</a><br>
+      <a href="/platform/overview/advanced-concepts/">Advanced Concepts &rarr;</a><br>
+      <a href="/platform/overview/creating-an-asset/">Creating an Asset  &rarr;</a><br>
+      <a href="/platform/overview/creating-an-event-against-an-asset/">Creating an Event Against an Asset &rarr;</a><br>
+      <a href="/platform/overview/registering-a-document-profile-asset/">Registering a Document Profile Asset &rarr;</a><br>
+      <a href="/platform/overview/public-attestation/">Public Attestation &rarr;</a><br>
+      <a href="/platform/overview/scitt-receipts/">Verify RKVST SCITT Receipts &rarr;</a><br>
+      <a href="/platform/overview/instaproof/">Instaproof &rarr;</a></p>
+    </div>
+</div>
diff --git a/layouts/404.html b/layouts/404.html
@@ -1,7 +1,7 @@
 {{ define "main" }}
 <section class="section section-sm">
   <div class="container">
-    <div class="row justify-content-center">
+    <div class="row justify-content-center" style="padding-top: 100px; padding-bottom: 100px;">
       <div class="col-md-12 col-lg-8 col-xl-6">
         <article>
           <h1 class="text-left">We couldn't find the page you were looking for.</h1>

diff --git a/layouts/developers/list.html b/layouts/developers/list.html
@@ -1,22 +1,12 @@
 {{ define "main" }}
 <div class="row justify-content-center">
-  <div class="col-md-12 col-lg-10 col-xl-8">
+  <div>
     <article>
-      <h1 class="text-center">{{ .Title }}</h1>
-      <div class="text">{{ .Content }}</div>
-			<div class="card-list">
-				{{ $currentSection := .CurrentSection }}
-				{{ range where .Site.RegularPages.ByTitle "Section" .Section }}
-					{{ if in (.RelPermalink | string) $currentSection.RelPermalink }}
-						<div class="card my-3">
-							<div class="card-body">
-								<a class="stretched-link" href="{{ .RelPermalink }}">{{ .Params.title | title }} &rarr;</a>
-							</div>
-						</div>
-					{{ end }}
-				{{ end }}
-			</div>
-    </article>
+      <div class="text-left" style="padding-bottom: 50px;">{{ .Content }}</div>
+	  </article>
   </div>
 </div>
-{{ end }}
+{{ end }}
+
+
+
diff --git a/layouts/glossary/list.html b/layouts/glossary/list.html
@@ -2,21 +2,19 @@
 <div class="row justify-content-center">
   <div class="col-md-12 col-lg-10 col-xl-8">
     <article>
-      <h1 class="text-center">{{ .Title }}</h1>
+      <h1 class="text-left">{{ .Title }}</h1>
       <div class="text">{{ .Content }}</div>
-			<div class="card-list">
+			<div>
 				{{ $currentSection := .CurrentSection }}
 				{{ range where .Site.RegularPages.ByTitle "Section" .Section }}
 					{{ if in (.RelPermalink | string) $currentSection.RelPermalink }}
-						<div class="card my-3">
-							<div class="card-body">
-								<a class="stretched-link" href="{{ .RelPermalink }}">{{ .Params.title | title }} &rarr;</a>
-							</div>
+						<div>
+							<a href="{{ .RelPermalink }}">{{ .Params.title | title }} &rarr;</a>
 						</div>
 					{{ end }}
 				{{ end }}
 			</div>
-    </article>
+    </article><br>
   </div>
 </div>
 {{ end }}
diff --git a/layouts/index.html b/layouts/index.html
@@ -21,8 +21,8 @@ <h1 class="mt-0">{{ .Title }}</h1>
         <div class="card" style="max-width: 25rem;">
                 <div class="card-body">
                         <h5 class="card-title">Developers</h5>
-                        <p class="card-text">Start adding provenance to your apps and data using our simple APIs</p>
-                        <a href="/developers/developer-patterns/getting-access-tokens-using-app-registrations" class="btn btn-primary">Start Developing</a>
+                        <p class="card-text">Start adding provenance to your apps and data using our simple APIs</p><br>
+                        <a href="/developers/" class="btn btn-primary">Start Developing</a>
                 </div>
         </div>
       </div>
@@ -31,7 +31,7 @@ <h5 class="card-title">Developers</h5>
   		        <div class="card-body">
     			           <h5 class="card-title">Platform</h5>
     			            <p class="card-text">Learn RKVST Fundamentals including creating your Assets, adding Events and sharing them</p>
-    			            <a href="/platform/overview/introduction/" class="btn btn-primary">Jump In</a>
+    			            <a href="/platform/" class="btn btn-primary">Jump In</a>
   		       </div>
       	</div>
       </div>      
@@ -40,7 +40,7 @@ <h5 class="card-title">Platform</h5>
                 <div class="card-body">
                         <h5 class="card-title">Use Cases & Examples</h5>
                         <p class="card-text">Find out how other Users leverage RKVST to bring automated trust to their business</p>
-                        <a href="/usecases/authenticity-and-attestation/" class="btn btn-primary">Be Inspired</a>
+                        <a href="/usecases/" class="btn btn-primary">Be Inspired</a>
                 </div>
         </div>
       </div>      
@@ -49,7 +49,7 @@ <h5 class="card-title">Use Cases & Examples</h5>
                 <div class="card-body">
                         <h5 class="card-title">Glossary</h5>
                         <p class="card-text">We strive for clarity but jargon is unavoidable! Decode ours here.<br><br></p>
-                        <a href="/glossary/common-rkvst-terms/" class="btn btn-primary">Find Out</a>
+                        <a href="/glossary/" class="btn btn-primary">Find Out</a>
                 </div>
         </div>
       </div>

diff --git a/layouts/platform/list.html b/layouts/platform/list.html
@@ -1,22 +1,9 @@
 {{ define "main" }}
 <div class="row justify-content-center">
-  <div class="col-md-12 col-lg-10 col-xl-8">
+  <div>
     <article>
-      <h1 class="text-center">{{ .Title }}</h1>
-      <div class="text">{{ .Content }}</div>
-			<div class="card-list">
-				{{ $currentSection := .CurrentSection }}
-				{{ range where .Site.RegularPages.ByTitle "Section" .Section }}
-					{{ if in (.RelPermalink | string) $currentSection.RelPermalink }}
-						<div class="card my-3">
-							<div class="card-body">
-								<a class="stretched-link" href="{{ .RelPermalink }}">{{ .Params.title | title }} &rarr;</a>
-							</div>
-						</div>
-					{{ end }}
-				{{ end }}
-			</div>
-    </article>
+      <div class="text-left" style="padding-bottom: 50px;">{{ .Content }}</div>
+	  </article>
   </div>
 </div>
 {{ end }}