Skip to content

Commit aef4397

Browse files
committed
Update frontmatter for website
Signed-off-by: mohin7 <csemohin@gmail.com>
1 parent b5c7ce1 commit aef4397

29 files changed

Lines changed: 303 additions & 144 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22
title: Contributing | KubeObj
33
description: Contributing
44
menu:
5-
docs_{{ .version }}:
5+
docs_v2025.10.31:
66
identifier: contributing-kubeobj
77
name: Contributing
88
parent: welcome
99
weight: 10
10-
menu_name: docs_{{ .version }}
10+
menu_name: docs_v2025.10.31
1111
section_menu_id: welcome
12-
url: /docs/{{ .version }}/welcome/contributing/
12+
url: /docs/v2025.10.31/welcome/contributing/
1313
aliases:
14-
- /docs/{{ .version }}/CONTRIBUTING/
14+
- /docs/v2025.10.31/CONTRIBUTING/
15+
info:
16+
cli: v0.20.0
17+
installer: v2025.10.31
18+
version: v2025.10.31
1519
---
1620

1721
# Contribution Guidelines

docs/README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,51 @@
22
title: Welcome | KubeObj
33
description: Welcome to KubeObj
44
menu:
5-
docs_{{ .version }}:
5+
docs_v2025.10.31:
66
identifier: readme-kubeobj
77
name: Readme
88
parent: welcome
99
weight: -1
10-
menu_name: docs_{{ .version }}
10+
menu_name: docs_v2025.10.31
1111
section_menu_id: welcome
12-
url: /docs/{{ .version }}/welcome/
12+
url: /docs/v2025.10.31/welcome/
1313
aliases:
14-
- /docs/{{ .version }}/
15-
- /docs/{{ .version }}/README/
14+
- /docs/v2025.10.31/
15+
- /docs/v2025.10.31/README/
16+
info:
17+
cli: v0.20.0
18+
installer: v2025.10.31
19+
version: v2025.10.31
1620
---
1721

1822
# NooBaa
1923

2024
[NooBaa]() is an open-source, cloud-native data management and object storage platform. It enables unified data access, multi-cloud federation, and seamless scalability by abstracting underlying storage resources. NooBaa helps organizations manage, migrate, and protect data across on-premises and cloud environments efficiently.
2125

22-
## [Concepts](/docs/concepts/)
26+
## [Concepts](/docs/v2025.10.31/concepts/)
2327
Concept explains some significant aspect of NooBaa. This is where you can learn about what NooBaa does and how it does it.
2428

25-
- [NooBaa Overview](/docs/concepts/what-is-noobaa/overview/index.md) Provides an introduction to NooBaa and gives an overview of the features it provides.
26-
- [NooBaa API](/docs/concepts/crds/backingstore/index.md) Introduces NooBaa CRDs.
29+
- [NooBaa Overview](/docs/v2025.10.31/concepts/what-is-noobaa/overview/) Provides an introduction to NooBaa and gives an overview of the features it provides.
30+
- [NooBaa API](/docs/v2025.10.31/concepts/crds/backingstore/) Introduces NooBaa CRDs.
2731

2832

29-
## [Setup](/docs/setup/)
33+
## [Setup](/docs/v2025.10.31/setup/)
3034

3135
Setup contains instructions for installing, uninstalling, and upgrading KubeStash.
3236

3337
- **Install NooBaa:** Provides instructions for installing NooBaa.
34-
- [Install](/docs/setup/install/index.md) How to install KubeStash.
38+
- [Install](/docs/v2025.10.31/setup/install/) How to install KubeStash.
3539

3640

37-
## [Guides](/docs/guides/)
41+
## [Guides](/docs/v2025.10.31/guides/)
3842

3943
Guides section shows how to perform different operations with NooBaa.
4044

41-
- [Cloud Native Operations](/docs/guides/cloud-native-operation/index.md): Describes how to manage cloud-native experience for object storage management.
42-
- [On Prem With Scalability](/docs/guides/on-prem-with-scalability/index.md): Explains how to deploy and scale NooBaa on-premises.
43-
- [Multi Cloud Federation](/docs/guides/multi-cloud-federation/index.md): Describes how to federate data across multiple clouds.
44-
- [Unified Data Access](/docs/guides/unified-data-access/index.md): Guides on accessing data from various storage systems through a single endpoint.
45-
- [Data Replication](/docs/guides/data-replication-policy/index.md): Provides instructions for setting up a highly available NooBaa deployment.
46-
- [High Availability](/docs/guides/high-availability/index.md): Describes how we can achive highly available NooBaa deployment.
45+
- [Cloud Native Operations](/docs/v2025.10.31/guides/cloud-native-operation/): Describes how to manage cloud-native experience for object storage management.
46+
- [On Prem With Scalability](/docs/v2025.10.31/guides/on-prem-with-scalability/): Explains how to deploy and scale NooBaa on-premises.
47+
- [Multi Cloud Federation](/docs/v2025.10.31/guides/multi-cloud-federation/): Describes how to federate data across multiple clouds.
48+
- [Unified Data Access](/docs/v2025.10.31/guides/unified-data-access/): Guides on accessing data from various storage systems through a single endpoint.
49+
- [Data Replication](/docs/v2025.10.31/guides/data-replication-policy/): Provides instructions for setting up a highly available NooBaa deployment.
50+
- [High Availability](/docs/v2025.10.31/guides/high-availability/): Describes how we can achive highly available NooBaa deployment.
4751

4852
We're always looking for help improving our documentation, so please don't hesitate to [file an issue](https://github.com/kubeobj/) if you see some problem.

docs/_index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
title: KubeObj
33
description: KubeObj
44
menu:
5-
docs_{{ .version }}:
5+
docs_v2025.10.31:
66
identifier: welcome
77
name: Welcome
8-
weight: 10
9-
menu_name: docs_{{ .version }}
8+
weight: 1
9+
menu_name: docs_v2025.10.31
10+
info:
11+
cli: v0.20.0
12+
installer: v2025.10.31
13+
version: v2025.10.31
1014
---
15+

docs/concepts/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
---
22
title: Readme
33
menu:
4-
docs_{{ .version }}:
4+
docs_v2025.10.31:
55
identifier: readme-concepts
66
name: Readme
7-
parent: concepts-docs
7+
parent: concepts
88
weight: 1
9-
menu_name: docs_{{ .version }}
9+
menu_name: docs_v2025.10.31
1010
section_menu_id: concepts
11+
url: /docs/v2025.10.31/concepts/
12+
aliases:
13+
- /docs/v2025.10.31/concepts/README/
14+
info:
15+
cli: v0.20.0
16+
installer: v2025.10.31
17+
version: v2025.10.31
1118
---
1219

1320
# Concepts
@@ -16,12 +23,12 @@ Concepts help you to learn about the different parts of the NooBaa and the abstr
1623
This concept section is divided into the following modules:
1724

1825
## What is NooBaa?
19-
- [Overview](/docs/concepts/what-is-noobaa/overview/index.md) provides an introduction to NooBaa. It also gives an overview of the features it provides.
26+
- [Overview](/docs/v2025.10.31/concepts/what-is-noobaa/overview/) provides an introduction to NooBaa. It also gives an overview of the features it provides.
2027

2128
## Declarative API
2229

23-
- [NooBaa](/docs/concepts/crds/noobaa/index.md): This is the central CRD for a NooBaa deployment. It represents the entire NooBaa system and orchestrates all its components. Administrators interact with this resource to install, configure, and manage the NooBaa platform within a Kubernetes cluster.
24-
- [BackingStore](/docs/concepts/crds/backingstore/index.md): A `BackingStore` represents underlying storage resources that NooBaa can use to store data. These can be cloud-based storage services (like AWS S3, Azure Blob Storage, or Google Cloud Storage) or on-premises storage systems (like a PV pool). `BackingStore`s are used to create buckets and provide the physical storage layer.
25-
- [NamespaceStore](/docs/concepts/crds/namespacestore/index.md): A `NamespaceStore` is a special type of `BackingStore` that represents an entire external bucket or a prefix within a bucket. Instead of using the external storage as a backing for NooBaa's own data services (like deduplication and compression), a `NamespaceStore` provides a direct, transparent connection to the external resource. This is useful for data federation and accessing existing data in place.
26-
- [BucketClass](/docs/concepts/crds/bucketclass/index.md): A `BucketClass` defines policies for how data is placed and managed across one or more `BackingStore`s. It can specify data placement policies like mirroring or spreading data across different stores. When a user requests a new bucket, they can specify a `BucketClass` to control the behavior and characteristics of their bucket.
27-
- [ObjectBucketClaim](/docs/concepts/crds/objectbucketclaim/index.md): An `ObjectBucketClaim` (OBC) is a Kubernetes-native way for a user or application to request a new object storage bucket, similar to how a `PersistentVolumeClaim` (PVC) requests block or file storage. When an OBC is created, the NooBaa operator provisions a corresponding `ObjectBucket` and makes the connection details available to the application via a `Secret` and a `ConfigMap`.
30+
- [NooBaa](/docs/v2025.10.31/concepts/crds/noobaa/): This is the central CRD for a NooBaa deployment. It represents the entire NooBaa system and orchestrates all its components. Administrators interact with this resource to install, configure, and manage the NooBaa platform within a Kubernetes cluster.
31+
- [BackingStore](/docs/v2025.10.31/concepts/crds/backingstore/): A `BackingStore` represents underlying storage resources that NooBaa can use to store data. These can be cloud-based storage services (like AWS S3, Azure Blob Storage, or Google Cloud Storage) or on-premises storage systems (like a PV pool). `BackingStore`s are used to create buckets and provide the physical storage layer.
32+
- [NamespaceStore](/docs/v2025.10.31/concepts/crds/namespacestore/): A `NamespaceStore` is a special type of `BackingStore` that represents an entire external bucket or a prefix within a bucket. Instead of using the external storage as a backing for NooBaa's own data services (like deduplication and compression), a `NamespaceStore` provides a direct, transparent connection to the external resource. This is useful for data federation and accessing existing data in place.
33+
- [BucketClass](/docs/v2025.10.31/concepts/crds/bucketclass/): A `BucketClass` defines policies for how data is placed and managed across one or more `BackingStore`s. It can specify data placement policies like mirroring or spreading data across different stores. When a user requests a new bucket, they can specify a `BucketClass` to control the behavior and characteristics of their bucket.
34+
- [ObjectBucketClaim](/docs/v2025.10.31/concepts/crds/objectbucketclaim/): An `ObjectBucketClaim` (OBC) is a Kubernetes-native way for a user or application to request a new object storage bucket, similar to how a `PersistentVolumeClaim` (PVC) requests block or file storage. When an OBC is created, the NooBaa operator provisions a corresponding `ObjectBucket` and makes the connection details available to the application via a `Secret` and a `ConfigMap`.

docs/concepts/_index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
---
22
title: Concepts
33
menu:
4-
docs_{{ .version }}:
5-
identifier: concepts-docs
4+
docs_v2025.10.31:
5+
identifier: concepts
66
name: Concepts
7-
weight: 1
8-
menu_name: docs_{{ .version }}
7+
weight: 2
8+
menu_name: docs_v2025.10.31
9+
info:
10+
cli: v0.20.0
11+
installer: v2025.10.31
12+
version: v2025.10.31
913
---
1014

docs/concepts/crds/_index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
22
title: Crds
33
menu:
4-
docs_{{ .version }}:
5-
identifier: crds-concepts
4+
docs_v2025.10.31:
5+
identifier: crds
66
name: Crds
7-
parent: concepts-docs
8-
weight: 1
9-
menu_name: docs_{{ .version }}
7+
parent: concepts
8+
weight: 15
9+
menu_name: docs_v2025.10.31
10+
info:
11+
cli: v0.20.0
12+
installer: v2025.10.31
13+
version: v2025.10.31
1014
---
1115

docs/concepts/crds/backingstore/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
22
title: Index
33
menu:
4-
docs_{{ .version }}:
4+
docs_v2025.10.31:
55
identifier: index-backingstore
6-
name: Index
7-
parent: backingstore-crds
6+
name: BackingStore
7+
parent: crds
88
weight: 1
9-
menu_name: docs_{{ .version }}
9+
menu_name: docs_v2025.10.31
1010
section_menu_id: concepts
11+
info:
12+
cli: v0.20.0
13+
installer: v2025.10.31
14+
version: v2025.10.31
1115
---
1216

1317
# BackingStore

docs/concepts/crds/bucketclass/index.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
2-
title: Index
2+
title: BucketClass
33
menu:
4-
docs_{{ .version }}:
4+
docs_v2025.10.31:
55
identifier: index-bucketclass
6-
name: Index
7-
parent: bucketclass-crds
8-
weight: 1
9-
menu_name: docs_{{ .version }}
6+
name: BucketClass
7+
parent: crds
8+
weight: 2
9+
menu_name: docs_v2025.10.31
1010
section_menu_id: concepts
11+
info:
12+
cli: v0.20.0
13+
installer: v2025.10.31
14+
version: v2025.10.31
1115
---
1216

1317
# BucketClass

docs/concepts/crds/namespacestore/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
2-
title: Index
2+
title: NamespaceStore
33
menu:
4-
docs_{{ .version }}:
4+
docs_v2025.10.31:
55
identifier: index-namespacestore
6-
name: Index
7-
parent: namespacestore-crds
6+
name: NamespaceStore
7+
parent: crds
88
weight: 1
9-
menu_name: docs_{{ .version }}
9+
menu_name: docs_v2025.10.31
1010
section_menu_id: concepts
11+
info:
12+
cli: v0.20.0
13+
installer: v2025.10.31
14+
version: v2025.10.31
1115
---
1216

1317
# NamespaceStore

docs/concepts/crds/noobaa/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
2-
title: Index
2+
title: NooBaa
33
menu:
4-
docs_{{ .version }}:
4+
docs_v2025.10.31:
55
identifier: index-noobaa
6-
name: Index
7-
parent: noobaa-crds
6+
name: NooBaa
7+
parent: crds
88
weight: 1
9-
menu_name: docs_{{ .version }}
9+
menu_name: docs_v2025.10.31
1010
section_menu_id: concepts
11+
info:
12+
cli: v0.20.0
13+
installer: v2025.10.31
14+
version: v2025.10.31
1115
---
1216

1317
# NooBaa

0 commit comments

Comments
 (0)