Add content to index pages of /understand (#6270)

* Remove default layout metadata - It's the only layout - It's the default anyway - It adds unnecessary content to the front page matter metadata for pages, making it more likely to make a mistake editing what is there * Add content to index pages of /understand, fix a few page nits * Always that file you forget to update 🤦🏻
treeverse · Jul 27, 2023 · feb2d41 · feb2d41
1 parent 5ba488b
commit feb2d41
Show file tree

Hide file tree

Showing 88 changed files with 100 additions and 134 deletions.
diff --git a/cmd/lakectl/cmd/docs.go b/cmd/lakectl/cmd/docs.go
@@ -11,7 +11,6 @@ import (
 
 // language=markdown
 var cliReferenceHeader = `---
-layout: default
 title: lakectl (lakeFS command-line tool)
 description: lakeFS comes with its own native CLI client. Here you can see the complete command reference.
 parent: Reference

diff --git a/docs/404.md b/docs/404.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 permalink: /404.html
 nav_exclude: true
 ---

diff --git a/docs/cloud/auditing.md b/docs/cloud/auditing.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Auditing
 parent: lakeFS Cloud
 description: Auditing is a solution for lakeFS Cloud which enables tracking of events and activities performed within the solution. These logs capture information such as who accessed the solution, what actions were taken, and when they occurred.

diff --git a/docs/cloud/index.md b/docs/cloud/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: lakeFS Cloud
 description: This section includes lakeFS Cloud documentation
 nav_order: 80

diff --git a/docs/cloud/managed-gc.md b/docs/cloud/managed-gc.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Managed Garbage Collection
 description: Reduce the operational overhead of running garbage collection manually.
 parent: lakeFS Cloud

diff --git a/docs/cloud/private-link.md b/docs/cloud/private-link.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Private Link
 description: Private Link enables lakeFS Cloud to interact with your infrastructure using private networking.
 parent: lakeFS Cloud

diff --git a/docs/cloud/sso.md b/docs/cloud/sso.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Single Sign On (SSO)
 description: How to configure Single Sign On (SSO) for lakeFS Cloud.
 parent: lakeFS Cloud

diff --git a/docs/cloud/unity-delta-sharing.md b/docs/cloud/unity-delta-sharing.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Unity Delta Sharing
 parent: lakeFS Cloud
 description: The lakeFS Delta Sharing service lets you export DeltaLake and HMS-style tables stored on lakeFS over the Delta Sharing protocol. This is particularly useful with DataBricks Unity.

diff --git a/docs/enterprise/index.md b/docs/enterprise/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: lakeFS Enterprise
 description: lakeFS Enterprise is an enterprise-ready lakeFS solution providing additional features including RBAC, SSO and Support SLA.
 nav_order: 81

diff --git a/docs/enterprise/sso.md b/docs/enterprise/sso.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Single Sign On (SSO) in lakeFS Enterprise
 description: How to configure Single Sign On in lakeFS Enterprise.
 parent: lakeFS Enterprise

diff --git a/docs/howto/copying.md b/docs/howto/copying.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Copying data to/from lakeFS
 description: 
 parent: How-To

diff --git a/docs/howto/deploy/aws.md b/docs/howto/deploy/aws.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: AWS
 grand_parent: How-To
 parent: Install lakeFS

diff --git a/docs/howto/deploy/azure.md b/docs/howto/deploy/azure.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Azure
 grand_parent: How-To
 parent: Install lakeFS

diff --git a/docs/howto/deploy/gcp.md b/docs/howto/deploy/gcp.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: GCP
 grand_parent: How-To
 parent: Install lakeFS

diff --git a/docs/howto/deploy/index.md b/docs/howto/deploy/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Install lakeFS
 parent: How-To
 description: This section will guide you through deploying and setting up a production lakeFS environment.
@@ -16,4 +15,8 @@ redirect_from:
 # Deploy and Setup lakeFS
 
 For a hosted lakeFS service with guaranteed SLAs, try [lakeFS Cloud](https://lakefs.cloud)
-{: .note }
+{: .note }
+
+lakeFS releases include [binaries](https://github.com/treeverse/lakeFS/releases) for common operating systems, a [containerized option](https://hub.docker.com/r/treeverse/lakefs) or a [Helm chart](https://artifacthub.io/packages/helm/lakefs/lakefs).
+
+Check out our guides for running lakeFS on [AWS]({{ site.baseurl }}/howto/deploy/aws.md), [GCP]({{ site.baseurl }}/howto/deploy/gcp.md) and [more]({{ site.baseurl }}/howto/deploy).
diff --git a/docs/howto/deploy/onprem.md b/docs/howto/deploy/onprem.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: On-Premises Deployment of lakeFS
 grand_parent: How-To
 parent: Install lakeFS

diff --git a/docs/howto/deploy/upgrade.md b/docs/howto/deploy/upgrade.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Upgrade lakeFS
 description: A guide to upgrading lakeFS to the latest version.
 grand_parent: How-To

diff --git a/docs/howto/export.md b/docs/howto/export.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Export Data
 description: Use the lakeFS Spark client or RClone inside Docker to export a lakeFS commit to the object store.
 parent: How-To

diff --git a/docs/howto/garbage-collection-committed.md b/docs/howto/garbage-collection-committed.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: (deprecated) Committed Objects
 description: Clean up unnecessary objects using the garbage collection feature in lakeFS.
 parent: Garbage Collection

diff --git a/docs/howto/garbage-collection-index.md b/docs/howto/garbage-collection-index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Garbage Collection
 description: Clean up unnecessary objects using the garbage collection feature in lakeFS.
 parent: How-To

diff --git a/docs/howto/garbage-collection-uncommitted.md b/docs/howto/garbage-collection-uncommitted.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: (deprecated) Uncommitted Objects
 description: Clean up uncommitted objects that are no longer needed.
 parent: Garbage Collection

diff --git a/docs/howto/garbage-collection.md b/docs/howto/garbage-collection.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Garbage Collection
 description: Clean up expired objects using the garbage collection feature in lakeFS.
 parent: Garbage Collection

diff --git a/docs/howto/gc-internals.md b/docs/howto/gc-internals.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: "Internals: Committed GC"
 description: How Garbage Collection in lakeFS works
 parent: Garbage Collection

diff --git a/docs/howto/hooks/airflow.md b/docs/howto/hooks/airflow.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Airflow Hooks
 parent: Actions and Hooks
 grand_parent: How-To

diff --git a/docs/howto/hooks/index.md b/docs/howto/hooks/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Actions and Hooks
 description: Overview of lakeFS Actions and Hooks
 has_children: true  

diff --git a/docs/howto/hooks/lua.md b/docs/howto/hooks/lua.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Lua Hooks
 parent: Actions and Hooks
 grand_parent: How-To

diff --git a/docs/howto/hooks/webhooks.md b/docs/howto/hooks/webhooks.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Webhooks
 parent: Actions and Hooks
 grand_parent: How-To

diff --git a/docs/howto/import.md b/docs/howto/import.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Import data
 description: Import existing data into a lakeFS repository
 parent: How-To

diff --git a/docs/howto/index.md b/docs/howto/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: How-To
 description: How to perform various tasks in lakeFS
 nav_order: 5

diff --git a/docs/howto/migrate-away.md b/docs/howto/migrate-away.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Migrating away from lakeFS
 description: The simplest way to migrate away from lakeFS is by copying data from a lakeFS repository to an S3 bucket.
 parent: How-To

diff --git a/docs/howto/protect-branches.md b/docs/howto/protect-branches.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Protect Branches
 description: Branch protection rules prevent direct changes from being applied to your important branches.
 parent: How-To

diff --git a/docs/howto/sizing-guide.md b/docs/howto/sizing-guide.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Sizing Guide
 parent: How-To
 description: This section provides a detailed sizing guide for deploying lakeFS.

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Welcome to lakeFS 👋🏻
 description: The lakeFS documentation provides guidance on how to use lakeFS to deliver resilience and manageability to data lakes.
 nav_order: 0

diff --git a/docs/integrations/airbyte.md b/docs/integrations/airbyte.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Airbyte
 description: Use Airbyte with lakeFS to easily sync data between applications and S3 with lakeFS version control.
 parent: Integrations

diff --git a/docs/integrations/airflow.md b/docs/integrations/airflow.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Airflow
 description: Easily build reproducible data pipelines with Airflow and lakeFS using commits, without modifying the code or logic of your job.
 parent: Integrations

diff --git a/docs/integrations/athena.md b/docs/integrations/athena.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Amazon Athena
 description: This section shows how you can start querying data from lakeFS using Amazon Athena.
 parent: Integrations

diff --git a/docs/integrations/aws_cli.md b/docs/integrations/aws_cli.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: AWS CLI
 description: This section shows how to use the AWS CLI for AWS S3 to access lakeFS.
 parent: Integrations

diff --git a/docs/integrations/cloudera.md b/docs/integrations/cloudera.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Cloudera
 description: Accessing data in lakeFS from Cloudera Spark works the same as accessing S3 data from Apache Spark.
 parent: Integrations

diff --git a/docs/integrations/dbt.md b/docs/integrations/dbt.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: dbt
 description: This guide covers maintaining environments with dbt and lakeFS.
 parent: Integrations

diff --git a/docs/integrations/delta.md b/docs/integrations/delta.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Delta Lake
 description: This section explains how to use Delta Lake with lakeFS.
 parent: Integrations

diff --git a/docs/integrations/dremio.md b/docs/integrations/dremio.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Dremio
 description: This section shows how you can start using lakeFS with Dremio, a next-generation data lake engine.
 parent: Integrations

diff --git a/docs/integrations/duckdb.md b/docs/integrations/duckdb.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: DuckDB
 description: How to use lakeFS with DuckDB, an open-source SQL OLAP database management system.
 parent: Integrations

diff --git a/docs/integrations/glue_hive_metastore.md b/docs/integrations/glue_hive_metastore.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Glue / Hive metastore
 description: This section explains how to query data from lakeFS branches in services backed by Glue/Hive Metastore.
 parent: Integrations

diff --git a/docs/integrations/hive.md b/docs/integrations/hive.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Hive
 description: This section covers how you can start using lakeFS with Apache Hive, a distributed data warehouse system that enables analytics at a massive scale.
 parent: Integrations

diff --git a/docs/integrations/iceberg.md b/docs/integrations/iceberg.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Apache Iceberg
 description: How to integrate lakeFS with Apache Iceberg
 parent: Integrations

diff --git a/docs/integrations/index.md b/docs/integrations/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Integrations
 description: Integrate lakeFS with all modern data frameworks such as Spark, Apache Iceberg, Hive, AWS Athena, Presto, and more.
 nav_order: 10

diff --git a/docs/integrations/kafka.md b/docs/integrations/kafka.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Kafka
 description: This section explains how you can start using lakeFS with Kafka using Confluent’s S3 Sink Connector.
 parent: Integrations

diff --git a/docs/integrations/kubeflow.md b/docs/integrations/kubeflow.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Kubeflow
 description: Easily build reproducible data pipelines with Kubeflow and lakeFS using commits, without modifying the code or logic of your job.
 parent: Integrations

diff --git a/docs/integrations/presto_trino.md b/docs/integrations/presto_trino.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Presto/Trino
 description: This section explains how you can start using lakeFS with Presto/Trino, an open-source distributed SQL query engine.
 parent: Integrations

diff --git a/docs/integrations/python.md b/docs/integrations/python.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Python
 description: Use Python to interact with your objects on lakeFS
 parent: Integrations

diff --git a/docs/integrations/r.md b/docs/integrations/r.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: R
 description: How to use lakeFS from R including creating branches, committing changes, and merging.
 parent: Integrations

diff --git a/docs/integrations/sagemaker.md b/docs/integrations/sagemaker.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: SageMaker
 description: This section explains how to integrate your SageMaker installation to work with lakeFS.
 parent: Integrations

diff --git a/docs/integrations/spark.md b/docs/integrations/spark.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Spark
 description: Accessing data in lakeFS from Apache Spark works the same as accessing S3 data from Apache Spark.
 parent: Integrations

diff --git a/docs/posts/index.md b/docs/posts/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 has_children: true
 search_exclude: true
 ---
diff --git a/docs/posts/security_update.md b/docs/posts/security_update.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 parent: posts
 has_children: false
 date: 2023-01-31

diff --git a/docs/project/contributing.md b/docs/project/contributing.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Contributing to lakeFS
 description: lakeFS community welcomes your contribution. To make the process as seamless as possible, we recommend reading this contribution guide first.
 parent: The lakeFS Project

diff --git a/docs/project/docs/callouts.md b/docs/project/docs/callouts.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Callouts
 description: Using and Customising Callouts in lakeFS Documentation
 parent: Documentation

diff --git a/docs/project/index.md b/docs/project/index.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: The lakeFS Project
 description: lakeFS is an open-source project under the Apache 2.0 license, committed to fostering the open-source space. 
 nav_order: 100

diff --git a/docs/quickstart/learning-more-lakefs.md b/docs/quickstart/learning-more-lakefs.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: 🧑🏻‍🎓 Learn more about lakeFS
 description: Learn more about lakeFS here with links to resources including quickstart, samples, installation guides, and more. 
 parent: ⭐ Quickstart ⭐

diff --git a/docs/reference/access-control-lists.md b/docs/reference/access-control-lists.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Access Control Lists (ACLs)
 parent: Reference
 description: Access control lists (ACLs) are one of the resource-based options that you can use to manage access to your repositories and objects. There are limits to managing permissions using ACLs.

diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: API Reference
 description: This section includes the reference documentation for the lakeFS platform's various APIs.
 parent: Reference

diff --git a/docs/reference/authentication.md b/docs/reference/authentication.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Authentication 
 description: This section covers Authentication of your lakeFS server.
 parent: Reference

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: lakectl (lakeFS command-line tool)
 description: lakeFS comes with its own native CLI client. Here you can see the complete command reference.
 parent: Reference

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -1,5 +1,4 @@
 ---
-layout: default
 title: Configuration
 description: Configuring lakeFS is done using a YAML configuration file. This reference uses `.` to denote the nesting of values.
 parent: Reference