HDDS-9865. Add outline of docs sections and pages. (#53)

README.md

@@ -14,7 +14,7 @@
 
 # Apache Ozone Website v2
 
-Welcome to the development branch of the new and improved Apache Ozone website. The new site is being built with [Docusaurus](https://docusaurus.io/). See the [Docusaurus docs](https://docusaurus.io/docs) for details on working with this framework.
+Welcome to the development branch of the new and improved Apache Ozone website. The new site is being built with [Docusaurus](https://docusaurus.io/). See the [Docusaurus docs](https://docusaurus.io/docs) for details on working with this framework. The `progress.sh` script can be used to get an approximation of how many pages are remaining before the website is ready.
 
 You can preview the current state of the new website at https://ozone-site-v2.staged.apache.org.
 

docs/01-overview.md

@@ -5,7 +5,7 @@ slug: /
 
 # Overview
 
-**TODO:** [HDDS-9864](https://issues.apache.org/jira/browse/HDDS-9864) and complete this page
+**TODO:** [HDDS-9864](https://issues.apache.org/jira/browse/HDDS-9864) complete this page
 
 ## What is Ozone?
 

docs/02-quick-start/01-installation/01-docker.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Docker
+---
+
+# Try Ozone With Docker
+
+**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section.

docs/02-quick-start/01-installation/02-kubernetes.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Kubernetes
+---
+
+# Try Ozone With Kubernetes
+
+**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section.

docs/02-quick-start/01-installation/03-bare-metal.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Bare Metal
+---
+
+# Try Ozone on Bare Metal
+
+**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section.

docs/02-quick-start/01-installation/_category_.yml

@@ -0,0 +1 @@
+label: Installation

docs/02-quick-start/02-reading-writing-data.md

@@ -0,0 +1,3 @@
+# Reading and Writing Data
+
+**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section.

docs/02-quick-start/_category_.yml

@@ -0,0 +1 @@
+label: Quick Start

docs/03-core-concepts/01-architecture.md

@@ -0,0 +1,6 @@
+# Architecture
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+
+A high level overview of Ozone's components and what they do.
+

docs/03-core-concepts/02-replication/01-storage-containers.md

@@ -0,0 +1,6 @@
+# Storage Containers
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+
+Provide a high level summary of storage containers and their purpose. Technically this is just for context and deep understanding is not required by most users of the system. The System Internals section of the docs will have much more details on containers.
+

docs/03-core-concepts/02-replication/02-write-pipelines.md

@@ -0,0 +1,6 @@
+# Write Pipelines
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+
+Provide a high level summary of write pipelines and their purpose. Technically this is just for context and deep understanding is not required by most users of the system. The System Internals section of the docs will have much more details on write pipelines.
+

docs/03-core-concepts/02-replication/03-ratis.md

@@ -0,0 +1,3 @@
+# Ratis
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/02-replication/04-erasure-coding.md

@@ -0,0 +1,3 @@
+# Erasure Coding
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/02-replication/_category_.yml

@@ -0,0 +1 @@
+label: Replication

docs/03-core-concepts/03-namespace/01-overview.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Overview
+---
+
+# Overview of Ozone's Namespace
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/01-volumes/01-overview.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Overview
+---
+
+# Volumes Overview
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/01-volumes/02-owners.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Owners
+---
+
+# Volume Owners
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/01-volumes/03-quotas.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Quotas
+---
+
+# Volume Quotas
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/01-volumes/_category_.yml

@@ -0,0 +1 @@
+label: Volumes

docs/03-core-concepts/03-namespace/02-buckets/01-overview.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Overview
+---
+
+# Buckets Overview
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/02-owners.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Owners
+---
+
+# Bucket Owners
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/03-quotas.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Quotas
+---
+
+# Bucket Quotas
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/04-layouts/01-object-store.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Object Store (OBS)
+---
+
+# Object Store Buckets (OBS)
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/04-layouts/02-file-system-optimized.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: File System Optimized (FSO)
+---
+
+# File System Optimized Buckets (FSO)
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/04-layouts/_category_.yml

@@ -0,0 +1 @@
+label: Layouts

docs/03-core-concepts/03-namespace/02-buckets/05-replication.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Default Replication Type
+---
+
+# Bucket Level Default Replication Type
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/06-encryption.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Encryption
+---
+
+# Bucket Level Encryption
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/07-links.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Links
+---
+
+# Bucket Links
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/03-namespace/02-buckets/_category_.yml

@@ -0,0 +1 @@
+label: Buckets

docs/03-core-concepts/03-namespace/_category_.yml

@@ -0,0 +1 @@
+label: Namespace

docs/03-core-concepts/04-security/01-authentication/01-kerberos.md

@@ -0,0 +1,10 @@
+---
+sidebar_label: Kerberos
+---
+
+# Authenticating with Kerberos
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+
+## Using SPNEGO to Authenticate with Kerberos over HTTP
+

docs/03-core-concepts/04-security/01-authentication/02-knox.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: Apache Knox
+---
+
+# Authenticating with Apache Knox
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+

docs/03-core-concepts/04-security/01-authentication/03-s3-credentials.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: S3 Credentials
+---
+
+# Authenticating with S3 Credentials
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+

docs/03-core-concepts/04-security/01-authentication/_category_.yml

@@ -0,0 +1 @@
+label: Authentication

docs/03-core-concepts/04-security/02-authorization/01-native-acls.md

@@ -0,0 +1,3 @@
+# Native ACLs
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/04-security/02-authorization/02-ranger-acls.md

@@ -0,0 +1,3 @@
+# Ranger ACLs
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.

docs/03-core-concepts/04-security/02-authorization/_category_.yml

@@ -0,0 +1 @@
+label: Authorization

docs/03-core-concepts/04-security/_category_.yml

@@ -0,0 +1 @@
+label: Security

docs/03-core-concepts/05-configuration-files.md

@@ -0,0 +1,11 @@
+# Configuration Files
+
+**TODO:** File a subtask under [HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this page or section.
+
+Covers what configuration files exist in the system, their basic format, and where they are read from. Does not cover specific config keys to use.
+- ozone-site.xml
+- core-site.xml
+- application log4j
+- audit log4j
+- client log4j
+

docs/03-core-concepts/_category_.yml

@@ -0,0 +1 @@
+label: Core Concepts

docs/04-user-guide/01-client-interfaces/01-o3.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: o3 (Ozone Shell)
+---
+
+# o3: Ozone Shell
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/02-ofs.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: ofs
+---
+
+# ofs: Hadoop Compatible Interface
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/03-s3.md

@@ -0,0 +1,3 @@
+# S3 API
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/04-s3a.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: s3a
+---
+
+# Accessing Ozone with s3a
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/05-httpfs.md

@@ -0,0 +1,3 @@
+# HttpFS
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/06-java-client-api.md

@@ -0,0 +1,3 @@
+# Java Client API
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/01-client-interfaces/_category_.yml

@@ -0,0 +1 @@
+label: Client Interfaces

docs/04-user-guide/02-integrations/_category_.yml

@@ -0,0 +1 @@
+label: Integrations

docs/04-user-guide/02-integrations/hive.md

@@ -0,0 +1,3 @@
+# Hive
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/hue.md

@@ -0,0 +1,3 @@
+# Hue
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/iceberg.md

@@ -0,0 +1,3 @@
+# Iceberg
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/impala.md

@@ -0,0 +1,3 @@
+# Impala
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/oozie.md

@@ -0,0 +1,3 @@
+# Oozie
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/spark.md

@@ -0,0 +1,3 @@
+# Spark
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/02-integrations/trino.md

@@ -0,0 +1,3 @@
+# Trino
+
+**TODO:** File a subtask under [HDDS-9858](https://issues.apache.org/jira/browse/HDDS-9858) and complete this page or section.

docs/04-user-guide/_category_.yml

@@ -0,0 +1 @@
+label: User Guide

docs/05-administrator-guide/01-installation/01-deployment-architecture.md

@@ -0,0 +1,3 @@
+# Deployment Architecture
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.

docs/05-administrator-guide/01-installation/02-hardware-and-sizing.md

@@ -0,0 +1,3 @@
+# Hardware and Sizing
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.

docs/05-administrator-guide/01-installation/03-installing-binaries.md

@@ -0,0 +1,7 @@
+# Installing the Ozone Binaries
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+
+To obtain binaries, link either:
+- Downloads page to get the released tarball
+- Developer guide to build from source.

docs/05-administrator-guide/01-installation/_category_.yml

@@ -0,0 +1 @@
+label: Installation

docs/05-administrator-guide/02-configuration/01-basic/01-network/01-ozone-manager.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Ozone Manager
+---
+
+# Network Configuration for Ozone Manager
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.

docs/05-administrator-guide/02-configuration/01-basic/01-network/02-storage-container-manager.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: Storage Container Manager
+---
+
+# Network Configuration for Storage Container Manager
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+

docs/05-administrator-guide/02-configuration/01-basic/01-network/03-datanode.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: Datanodes
+---
+
+# Network Configuration for Datanodes
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+

docs/05-administrator-guide/02-configuration/01-basic/01-network/04-recon.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: Recon
+---
+
+# Network Configuration for Recon
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+

docs/05-administrator-guide/02-configuration/01-basic/01-network/05-s3-gateway.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: S3 Gateways
+---
+
+# Network Configuration for S3 Gateways
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+

docs/05-administrator-guide/02-configuration/01-basic/01-network/07-default-ports.md

@@ -0,0 +1,9 @@
+---
+sidebar_label: Default Ports
+---
+
+# Default Ports Used by Ozone
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.
+
+Include a list of all default port values used throughout Ozone.

docs/05-administrator-guide/02-configuration/01-basic/01-network/_category_.yml

@@ -0,0 +1 @@
+label: Network

docs/05-administrator-guide/02-configuration/01-basic/02-directories/01-ozone-manager.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Ozone Manager
+---
+
+# Directory Configurations for Ozone Manager
+
+**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section.