Create index for Sealed Secrets public documentation (#1264)

* Draft for the Index page Signed-off-by: Alfredo Garcia <[email protected]> * Documentation structure Signed-off-by: Alfredo Garcia <[email protected]> --------- Signed-off-by: Alfredo Garcia <[email protected]>
bitnami-labs · Jul 7, 2023 · 608e727 · 608e727
1 parent 07a2917
commit 608e727
Show file tree

Hide file tree

Showing 27 changed files with 153 additions and 489 deletions.
diff --git a/site/content/docs/_index.md b/site/content/docs/_index.md
@@ -1,55 +1,9 @@
 ---
-title: "Documentation"
+version: latest
 cascade:
   layout: docs
 ---
 
-![Logo](/docs/img/placeholder-750x250.png)
+# Sealed Secrets documentation
 
-## Overview
-
-Sit amet facilisis magna etiam tempor orci eu lobortis. 
-
-Sit amet nulla facilisi morbi tempus. Auctor neque vitae tempus quam pellentesque 
-nec nam aliquam sem. Dui ut ornare lectus sit. Donec pretium vulputate 
-sapien nec sagittis aliquam malesuada bibendum arcu. Congue nisi vitae 
-suscipit tellus mauris. Cursus turpis massa tincidunt dui ut ornare lectus. 
-Nunc mattis enim ut tellus elementum sagittis vitae. Bibendum at varius 
-vel pharetra vel turpis nunc eget lorem.
-
-### Gravida in fermentum
-
-* Sollicitudin ac orci phasellus. Cras tincidunt lobortis feugiat vivamus at augue eget: 
-  * Risus nullam eget felis eget nunc
-  * Ultrices neque ornare aenean euismod
-  * Elementum nisi quis eleifend quam 
-* Pellentesque eu tincidunt tortor aliquam nulla:
-  * Vestibulum lorem sed risus ultricies tristique nulla
-  * Vestibulum lectus mauris ultrices eros
-
-### Nisi quis eleifend 
-
-Quam adipiscing vitae proin sagittis. Suspendisse faucibus interdum posuere lorem ipsum dolor sit. Mauris cursus mattis molestie a iaculis at erat pellentesque adipiscing. Nisi est sit amet facilisis. In hac habitasse platea dictumst quisque sagittis. Viverra vitae congue eu consequat. In nulla posuere sollicitudin aliquam ultrices sagittis orci a. Scelerisque purus semper eget duis at tellus at. Molestie nunc non blandit massa enim nec dui nunc. At lectus urna duis convallis convallis tellus id.
-
-### Architecture
-
-Ut morbi tincidunt augue interdum velit. At risus viverra adipiscing at in. 
-Nulla facilisi cras fermentum odio eu feugiat pretium nibh. Mi quis hendrerit 
-dolor magna eget est lorem. Sed odio morbi quis commodo odio. Proin sed libero 
-enim sed faucibus turpis in eu.
-
-To learn more, see [docs/architecture](/docs/architecture).
-
-
-## See a demo
-
-Lectus vestibulum mattis ullamcorper velit. [See a demo](/docs/demo/)
-
-
-## See scope
-
-Suspendisse potenti dictum at tempor commodo. [See scope](/docs/scope/)
-
-## Update images
-
-Gravida in fermentum et sollicitudin ac orci. [Update images](/docs/img/)
+Explore the [latest version docs](./latest/) to get started.
diff --git a/site/content/docs/architecture.md b/site/content/docs/architecture.md
diff --git a/site/content/docs/demo.md b/site/content/docs/demo.md
diff --git a/site/content/docs/latest/CONTRIBUTING.md b/site/content/docs/latest/CONTRIBUTING.md
diff --git a/site/content/docs/latest/README.md b/site/content/docs/latest/README.md
@@ -0,0 +1,17 @@
+
+# Sealed Secrets documentation
+
+Everything you need to know about Sealed Secrets.
+
+> NOTE: we are currently moving our docs to a new website and reviewing our documentation files. During the process, eventual broken links and minor inconsistences may appear. Please, feel free to contact us if you have any questions: file an [issue](https://github.com/bitnami-labs/sealed-secrets/issues), or talk to us on the [#Sealed Secrets slack channel](https://kubernetes.slack.com/messages/sealed-secrets).
+
+## Documentation overview
+
+A high-level overview of how it's organized will help Sealed Secrets contributors and users know where to look for certain things.
+
+| Section                     | Description                                                                                         |
+| --------------------------- | ----------------------------------------------------------------------------------------------------|
+| [Tutorials](./tutorials/)   | Start here if you're new to Sealed Secrets. A hands-on introduction to Seled Secrets for new users. |
+| [How-to guides](./howto/)   | They guide you through the steps involved in addressing key problems and use-cases.                 |
+| [Background](./background/) | Dive into the overall architecture and implementation details of Sealed Secrets.                    |
+| [Reference](./reference/)   | Technical information - developer guides, design proposals, examples, translations, etc.            |
diff --git a/site/content/docs/latest/_index.md b/site/content/docs/latest/_index.md
@@ -4,52 +4,4 @@ cascade:
   layout: docs
 ---
 
-![Logo](/docs/img/placeholder-750x250.png)
-
-## Overview
-
-Sit amet facilisis magna etiam tempor orci eu lobortis. 
-
-Sit amet nulla facilisi morbi tempus. Auctor neque vitae tempus quam pellentesque 
-nec nam aliquam sem. Dui ut ornare lectus sit. Donec pretium vulputate 
-sapien nec sagittis aliquam malesuada bibendum arcu. Congue nisi vitae 
-suscipit tellus mauris. Cursus turpis massa tincidunt dui ut ornare lectus. 
-Nunc mattis enim ut tellus elementum sagittis vitae. Bibendum at varius 
-vel pharetra vel turpis nunc eget lorem.
-
-### Gravida in fermentum
-
-* Sollicitudin ac orci phasellus. Cras tincidunt lobortis feugiat vivamus at augue eget: 
-  * Risus nullam eget felis eget nunc
-  * Ultrices neque ornare aenean euismod
-  * Elementum nisi quis eleifend quam 
-* Pellentesque eu tincidunt tortor aliquam nulla:
-  * Vestibulum lorem sed risus ultricies tristique nulla
-  * Vestibulum lectus mauris ultrices eros
-
-### Nisi quis eleifend 
-
-Quam adipiscing vitae proin sagittis. Suspendisse faucibus interdum posuere lorem ipsum dolor sit. Mauris cursus mattis molestie a iaculis at erat pellentesque adipiscing. Nisi est sit amet facilisis. In hac habitasse platea dictumst quisque sagittis. Viverra vitae congue eu consequat. In nulla posuere sollicitudin aliquam ultrices sagittis orci a. Scelerisque purus semper eget duis at tellus at. Molestie nunc non blandit massa enim nec dui nunc. At lectus urna duis convallis convallis tellus id.
-
-### Architecture
-
-Ut morbi tincidunt augue interdum velit. At risus viverra adipiscing at in. 
-Nulla facilisi cras fermentum odio eu feugiat pretium nibh. Mi quis hendrerit 
-dolor magna eget est lorem. Sed odio morbi quis commodo odio. Proin sed libero 
-enim sed faucibus turpis in eu.
-
-To learn more, see [docs/architecture](/docs/architecture).
-
-
-## See a demo
-
-Lectus vestibulum mattis ullamcorper velit. [See a demo](/docs/demo/)
-
-
-## See scope
-
-Suspendisse potenti dictum at tempor commodo. [See scope](/docs/scope/)
-
-## Update images
-
-Gravida in fermentum et sollicitudin ac orci. [Update images](/docs/img/)
+{{%  readfile file="/content/docs/latest/README.md" %}}
diff --git a/site/content/docs/latest/architecture.md b/site/content/docs/latest/architecture.md
diff --git a/site/content/docs/latest/background/README.md b/site/content/docs/latest/background/README.md
@@ -0,0 +1,13 @@
+# Sealed Secrets Background
+
+Big-picture explanations of higher-level Sealed Secrets concepts. Most useful for building understanding of a particular topic.
+
+| Background                                         | Description                                                                                      |
+| -------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| [Cryptography](./cryptography.md)                  | Dive into the overall Sealed Secrets Cryptography.                                                     |
+
+Alternatively, if you have a specific goal, but are already familiar with Sealed Secrets, take a look at our [How-to guides](../howto/README.md). These have more in-depth detail and can be applied to a broader set of features.
+
+Take a look at our [Reference section](../reference/README.md) when you need to know design decisions, detailed developer guides, etc.
+
+Finally, our [Tutorials section](../tutorials/README.md) contains step-by-step tutorials to help outline what Sealed Secrets is capable of.
diff --git a/site/content/docs/latest/background/_index.md b/site/content/docs/latest/background/_index.md
@@ -0,0 +1,7 @@
+---
+version: latest
+cascade:
+  layout: docs
+---
+
+{{%  readfile file="/content/docs/latest/background/README.md" %}}