docs: adjust for new doc website

Signed-off-by: Joao Eduardo Luis <joao@behemoth.front.lab>
s3gw-tech · Mar 24, 2024 · 68f3340 · 68f3340
1 parent 80f5ba2
commit 68f3340
Show file tree

Hide file tree

Showing 28 changed files with 97 additions and 151 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/decisions/0000-use-markdown-any-decision-records.md b/docs/decisions/0000-use-markdown-any-decision-records.md
@@ -17,12 +17,12 @@ Where should the records live?
 
 ### Location
 
-- <https://github.com/aquarist-labs/s3gw>
+- [s3gw repository](https://github.com/s3gw-tech/s3gw)
 - SUSE Confluence
 
 ## Decision Outcome
 
-MADR in aquarist-labs/s3gw, because
+MADR in s3gw-tech/s3gw, because
 
 - Architecture, design and code decisions should be open and public
 - Github merge request workflow adds an easy review workflow we

diff --git a/docs/decisions/0010-sfs-versioning.md b/docs/decisions/0010-sfs-versioning.md
@@ -8,7 +8,7 @@ In this document we only look at tables Objects and Versioned Objects.
 
 An *object* has a name, id, and reference to a *bucket*
 
-A *object version* has an id, checksum, {create, commit, delete}_time,
+A *object version* has an id, checksum, \{create, commit, delete\}_time,
 mtime, size, **state**, **type**, ETag, serialized attributes, etc.
 
 An *object* is a group of versions identified by bucket and name.

diff --git a/docs/decisions/0011-sfs-timestamps.md b/docs/decisions/0011-sfs-timestamps.md
@@ -1,5 +1,5 @@
-<!-- #cSpell:words multicol datefunc -->
 # SFS Timestamps
+<!-- #cSpell:words multicol datefunc -->
 
 ## Context and Problem Statement
 

diff --git a/docs/decisions/0019-severity-labels.md b/docs/decisions/0019-severity-labels.md
@@ -39,7 +39,7 @@ issues should have a severity label set from now on.
 
 ### Longhorn
 
-This is the current severity labels used by <https://github.com/longhorn/longhorn/labels>:
+This is the current severity labels used by [Longhorn](https://github.com/longhorn/longhorn/labels):
 
 - severity/1
   - Function broken (a critical incident with very high impact (ex: data corruption, failed upgrade)
@@ -52,8 +52,7 @@ This is the current severity labels used by <https://github.com/longhorn/longhor
 
 ### openSUSE
 
-This is the current severity fields used for openSUSE bugs:
-<https://en.opensuse.org/openSUSE:Bug_definitions>
+This is the current severity fields used for [openSUSE bugs](https://en.opensuse.org/openSUSE:Bug_definitions):
 
 - Blocker
   - Prevents developers or testers from performing their jobs. Impacts the development process

diff --git a/docs/decisions/README.md b/docs/decisions/README.md
@@ -1,3 +1,8 @@
+---
+title: Introduction
+---
+
+<!-- markdownlint-disable MD025 -->
 # Decisions
 
 This directory contains decision records for s3gw.
@@ -10,5 +15,5 @@ This directory contains decision records for s3gw.
 
 ## Resources
 
-- MADRs <https://adr.github.io/madr/>.
-- General information about ADRs <https://adr.github.io/>.
+- [MADRs](https://adr.github.io/madr/)
+- [General information about ADRs](https://adr.github.io/)
diff --git a/docs/decisions/adr-template.md b/docs/decisions/adr-template.md
@@ -1,96 +1,99 @@
 ---
+title: Template
+
 # These are optional elements. Feel free to remove any of them.
-status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)}
-date: {YYYY-MM-DD when the decision was last updated}
-deciders: {list everyone involved in the decision}
-consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
-informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
+status: "proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)"
+date: "YYYY-MM-DD when the decision was last updated"
+deciders: "list everyone involved in the decision"
+consulted: "list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication"
+informed: "list everyone who is kept up-to-date on progress; and with whom there is a one-way communication"
 ---
 
-# {short title of solved problem and solution}
+<!-- markdownlint-disable MD025 -->
+# short title of solved problem and solution
 
 ## Context and Problem Statement
 
-{Describe the context and problem statement, e.g., in free form using two to
+Describe the context and problem statement, e.g., in free form using two to
 three sentences or in the form of an illustrative story. You may want to
 articulate the problem in form of a question and add links to collaboration
-boards or issue management systems.}
+boards or issue management systems.
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ## Decision Drivers
 
-- {decision driver 1, e.g., a force, facing concern, …}
-- {decision driver 2, e.g., a force, facing concern, …}
+- decision driver 1, e.g., a force, facing concern, …
+- decision driver 2, e.g., a force, facing concern, …
 - … <!-- numbers of drivers can vary -->
 
 ## Considered Options
 
-- {title of option 1}
-- {title of option 2}
-- {title of option 3}
+- title of option 1
+- title of option 2
+- title of option 3
 - … <!-- numbers of options can vary -->
 
 ## Decision Outcome
 
-Chosen option: "{title of option 1}", because {justification. e.g., only option,
-which meets k.o. criterion decision driver | which resolves force {force} | … |
-comes out best (see below)}.
+Chosen option: "title of option 1", because "justification. e.g., only option,
+which meets k.o. criterion decision driver | which resolves force 'force' | … |
+comes out best (see below)".
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ### Positive Consequences
 
-- {e.g., improvement of one or more desired qualities, …}
+- e.g., improvement of one or more desired qualities, …
 - …
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ### Negative Consequences
 
-- {e.g., compromising one or more desired qualities, …}
+- e.g., compromising one or more desired qualities, …
 - …
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ## Validation
 
-{describe how the implementation of/compliance with the ADR is validated. E.g.,
-by a review or an ArchUnit test}
+describe how the implementation of/compliance with the ADR is validated. E.g.,
+by a review or an ArchUnit test
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ## Pros and Cons of the Options
 
-### {title of option 1}
+### title of option 1
 
 <!-- This is an optional element. Feel free to remove. -->
 
-{example | description | pointer to more information | …}
+example | description | pointer to more information | …
 
-- Good, because {argument a}
-- Good, because {argument b}
+- Good, because "argument a"
+- Good, because "argument b"
 <!-- use "neutral" if the given argument weights neither for good nor bad -->
-- Neutral, because {argument c}
-- Bad, because {argument d}
+- Neutral, because "argument c"
+- Bad, because "argument d"
 - … <!-- numbers of pros and cons can vary -->
 
-### {title of other option}
+### title of other option
 
-{example | description | pointer to more information | …}
+example | description | pointer to more information | …
 
-- Good, because {argument a}
-- Good, because {argument b}
-- Neutral, because {argument c}
-- Bad, because {argument d}
+- Good, because "argument a"
+- Good, because "argument b"
+- Neutral, because "argument c"
+- Bad, because "argument d"
 - …
 
 <!-- This is an optional element. Feel free to remove. -->
 
 ## More Information
 
-{You might want to provide additional evidence/confidence for the decision
+You might want to provide additional evidence/confidence for the decision
 outcome here and/or document the team agreement on the decision and/or define
 when this decision when and how the decision should be realized and if/when it
 should be re-visited and/or how the decision is validated. Links to other
-decisions and resources might here appear as well.}
+decisions and resources might here appear as well.
diff --git a/docs/advanced-usage.md → docs/guide/advanced-usage.md b/docs/advanced-usage.md → docs/guide/advanced-usage.md
diff --git a/docs/config-s3gw.md → docs/guide/config-s3gw.md b/docs/config-s3gw.md → docs/guide/config-s3gw.md
diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md
@@ -0,0 +1,3 @@
+<!-- markdownlint-disable MD013 -->
+<!-- markdownlint-disable MD041 -->
+<!-- {{ external_markdown('https://raw.githubusercontent.com/s3gw-tech/s3gw/main/CONTRIBUTING.md', '') }} -->
diff --git a/docs/developing.md → docs/guide/developing.md b/docs/developing.md → docs/guide/developing.md
diff --git a/docs/helm-charts.md → docs/guide/helm-charts.md b/docs/helm-charts.md → docs/guide/helm-charts.md
diff --git a/docs/index.md → docs/guide/introduction.md b/docs/index.md → docs/guide/introduction.md
@@ -1,48 +1,50 @@
-# Welcome to the s3gw project
-
-## About the project
-
-The s3gw project is split into 4 work streams: [rgw/sfs-ceph][1] (backend),
-[s3gw][2] (tooling), [s3gw-charts][3] (helm charts) and [s3gw-ui][4]
-(frontend).
+---
+slug: /
+---
 
-## Project vision
+# Welcome to the s3gw project
 
-### What are we doing?
+## What are we doing?
 
 The s3gw project helps Kubernetes users who need object storage (S3) to back up
 their application data to a ([Longhorn][5]) PV by offering a lightweight, Open Source
 S3 service, which is easy to deploy in a Cloud Native world.
 
-### Why are we doing it?
+## Why are we doing it?
 
 We have identified a need for making cluster data backups easily available for
 apps that do not require petabyte-scale storage.
 
-### Features
+## Features
 
 - An intuitive UI
 - S3 API compatibility
 - Kubernetes-native management
 - Leverages the feature-rich S3 gateway from Ceph
 - Strong integration with the Rancher Portfolio
 
-### Use cases
+## Use cases
 
 - Epinio: Backups/CRDs
 - Harvester: Backups
 - OPNI: Backups
 - K3S/Edge
 - SAP Data Intelligence
 
-### Value proposition
+## Value proposition
 
 - Ideal for small-scale deployments/Edge
 - Lightweight, simple User Experience
 - Simple: Storage/replication handled by a PV ([Longhorn][5])
 - Designed to integrate with Rancher's product catalog
 - Open source licensing (Apache 2.0)
 
+## About the project
+
+The s3gw project is split into 4 work streams: [rgw/sfs-ceph][1] (backend),
+[s3gw][2] (tooling), [s3gw-charts][3] (helm charts) and [s3gw-ui][4]
+(frontend).
+
 [1]: https://github.com/s3gw-tech/s3gw-ceph
 [2]: https://github.com/s3gw-tech/s3gw
 [3]: https://github.com/s3gw-tech/s3gw-charts

diff --git a/docs/license.md → docs/guide/license.md b/docs/license.md → docs/guide/license.md
@@ -4,7 +4,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use licensed files except in compliance with the License.
 You may obtain a copy of the License at
 
-<http://www.apache.org/licenses/LICENSE-2.0>
+    http://www.apache.org/licenses/LICENSE-2.0
 
 or the LICENSE file in this repository.
 

diff --git a/docs/metrics.md → docs/guide/metrics.md b/docs/metrics.md → docs/guide/metrics.md
diff --git a/docs/quickstart.md → docs/guide/quickstart.md b/docs/quickstart.md → docs/guide/quickstart.md
@@ -6,7 +6,8 @@ You can install the s3gw via the Rancher App Catalog. The steps are as follows:
 
 - Cluster -> Projects/Namespaces - create the `s3gw` namespace.
 - Apps -> Repositories -> Create `s3gw` using the s3gw-charts Web URL
-  <https://s3gw-tech.github.io/s3gw-charts/> and the main branch.
+  [https://s3gw-tech.github.io/s3gw-charts/](https://s3gw-tech.github.io/s3gw-charts/)
+  and the main branch.
 - Apps -> Charts -> Install Traefik.
 - Apps -> Charts -> Install `s3gw`.
   Select the `s3gw` namespace previously created.

diff --git a/docs/roadmap.md → docs/guide/roadmap.md b/docs/roadmap.md → docs/guide/roadmap.md
diff --git a/docs/s3-compatibility-table.md → docs/guide/s3-compatibility-table.md b/docs/s3-compatibility-table.md → docs/guide/s3-compatibility-table.md
diff --git a/docs/guide/s3gw-repos.md b/docs/guide/s3gw-repos.md
@@ -0,0 +1,9 @@
+# S3GW Repositories
+
+The S3 Gateway includes the following projects:
+
+- [s3gw-tech/s3gw](https://github.com/s3gw-tech/s3gw)
+- [s3gw-tech/s3gw-ceph](https://github.com/s3gw-tech/s3gw-ceph)
+- [s3gw-tech/s3gw-charts](https://github.com/s3gw-tech/s3gw-charts)
+- [s3gw-tech/s3gw-status](https://github.com/s3gw-tech/s3gw-status)
+- [s3gw-tech/s3gw-cosi-driver](https://github.com/s3gw-tech/s3gw-cosi-driver)
diff --git a/docs/s3gw-with-k3s.md → docs/guide/s3gw-with-k3s.md b/docs/s3gw-with-k3s.md → docs/guide/s3gw-with-k3s.md
diff --git a/docs/s3gw-with-k8s.md → docs/guide/s3gw-with-k8s.md b/docs/s3gw-with-k8s.md → docs/guide/s3gw-with-k8s.md
diff --git a/docs/testing.md → docs/guide/testing.md b/docs/testing.md → docs/guide/testing.md
diff --git a/docs/troubleshoot-s3gw.md → docs/guide/troubleshoot-s3gw.md b/docs/troubleshoot-s3gw.md → docs/guide/troubleshoot-s3gw.md
diff --git a/docs/ui.md → docs/guide/ui.md b/docs/ui.md → docs/guide/ui.md
diff --git a/docs/ideas/PID-0-reserved.md b/docs/ideas/PID-0-reserved.md
@@ -1,6 +1,6 @@
 ---
 status: accepted
-tags: area/docs
+tags: [ area/docs ]
 updated: 20231013
 ---
 

diff --git a/docs/readme.md b/docs/readme.md