Skip to content

Commit

Permalink
[Docs] Remove redundant metadata (#6432)
Browse files Browse the repository at this point in the history
* Remove redundant metadata from docs

* Remove auto generated TOC

* Remove redundant toc metadata
  • Loading branch information
Robin Moffatt authored Aug 18, 2023
1 parent 62fdb51 commit 9c4005c
Show file tree
Hide file tree
Showing 62 changed files with 0 additions and 62 deletions.
1 change: 0 additions & 1 deletion cmd/lakectl/cmd/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ var cliReferenceHeader = `---
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
has_children: false
redirect_from:
- /reference/commands.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/copying.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Copying data to/from lakeFS
description:
parent: How-To
has_children: false
redirect_from:
- /integrations/distcp.html
- /integrations/rclone.html
Expand Down
1 change: 0 additions & 1 deletion docs/howto/deploy/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Upgrade lakeFS
description: How to upgrade lakeFS to the latest version.
grand_parent: How-To
parent: Install lakeFS
has_children: false
redirect_from:
- /deploying-aws/upgrade.html
- /reference/upgrade.html
Expand Down
1 change: 0 additions & 1 deletion docs/howto/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
has_children: false
redirect_from:
- /reference/export.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/garbage-collection/committed.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Clean up unnecessary objects using the garbage collection feature i
parent: Garbage Collection
grand_parent: How-To
nav_order: 98
has_children: false
redirect_from:
- /howto/garbage-collection-committed.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/garbage-collection/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: How Garbage Collection in lakeFS works
parent: Garbage Collection
grand_parent: How-To
nav_order: 2
has_children: false
redirect_from:
- /howto/gc-internals.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/garbage-collection/managed-gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Reduce the operational overhead of running garbage collection manua
parent: Garbage Collection
nav_order: 1
grand_parent: How-To
has_children: false
redirect_from:
- /cloud/managed-gc.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/garbage-collection/uncommitted.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Clean up uncommitted objects that are no longer needed.
parent: Garbage Collection
grand_parent: How-To
nav_order: 99
has_children: false
redirect_from:
- /howto/garbage-collection-uncommitted.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Import Data
description: Import existing data into a lakeFS repository
parent: How-To
has_children: false
redirect_from:
- /setup/import.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/migrate-away.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
has_children: false
redirect_from:
- /deploying-aws/offboarding.html
- /reference/offboarding.html
Expand Down
1 change: 0 additions & 1 deletion docs/howto/private-link.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Private Link
description: Private Link enables lakeFS Cloud to interact with your infrastructure using private networking.
has_children: false
parent: How-To
redirect_from:
- /cloud/private-link.html
Expand Down
1 change: 0 additions & 1 deletion docs/howto/protect-branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Protect Branches
description: Branch protection rules prevent direct changes from being applied to your important branches.
parent: How-To
has_children: false
redirect_from:
- /reference/protected_branches.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/howto/sizing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Sizing Guide
parent: How-To
description: This section provides a detailed sizing guide for deploying lakeFS.
has_children: false
redirect_from:
- /architecture/sizing-guide.html
- /understand/sizing-guide.html
Expand Down
1 change: 0 additions & 1 deletion docs/howto/unity-delta-sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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.
has_children: false
redirect_from:
- /cloud/unity-delta-sharing.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Airbyte
description: Use Airbyte with lakeFS to easily sync data between applications and S3 with lakeFS version control.
parent: Integrations
has_children: false
---

# Airbyte
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/airflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Apache Airflow
description: Easily build reproducible data pipelines with Airflow and lakeFS using commits, without modifying the code or logic of your job.
parent: Integrations
has_children: false
redirect_from: /using/airflow.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/athena.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Amazon Athena
description: This section shows how you can start querying data from lakeFS using Amazon Athena.
parent: Integrations
has_children: false
redirect_from: /using/athena.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/aws_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: AWS CLI
description: This section shows how to use the AWS CLI for AWS S3 to access lakeFS.
parent: Integrations
has_children: false
redirect_from: /using/aws_cli.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/cloudera.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Cloudera
description: Accessing data in lakeFS from Cloudera Spark works the same as accessing S3 data from Apache Spark.
parent: Integrations
has_children: false
redirect_from:
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/dbt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: dbt
description: Integrating dbt and lakeFS
parent: Integrations
has_children: false
redirect_from: /using/dbt.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/delta.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Delta Lake
description: This section explains how to use Delta Lake with lakeFS.
parent: Integrations
has_children: false
---

# Using lakeFS with Delta Lake
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/dremio.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Dremio
description: This section shows how you can start using lakeFS with Dremio, a next-generation data lake engine.
parent: Integrations
has_children: false
redirect_from: /using/dremio.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/duckdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: DuckDB
description: How to use lakeFS with DuckDB, an open-source SQL OLAP database management system.
parent: Integrations
has_children: false
---

# Using lakeFS with DuckDB
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/glue_hive_metastore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Glue / Hive metastore
description: This section explains how to query data from lakeFS branches in services backed by Glue/Hive Metastore.
parent: Integrations
has_children: false
redirect_from: /using/glue_hive_metastore.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/hive.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Apache 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
has_children: false
redirect_from: /using/hive.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/iceberg.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Apache Iceberg
description: How to integrate lakeFS with Apache Iceberg
parent: Integrations
has_children: false
---

# Using lakeFS with Apache Iceberg
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Apache Kafka
description: This section explains how you can start using lakeFS with Kafka using Confluent’s S3 Sink Connector.
parent: Integrations
has_children: false
redirect_from:
- /using/kakfa.html
- /integrations/kakfa.html
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
has_children: false

---
# Using lakeFS with Kubeflow pipelines
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/presto_trino.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Presto / Trino
description: This section explains how you can start using lakeFS with Presto and Trino, an open-source distributed SQL query engine.
parent: Integrations
has_children: false
redirect_from:
- /integrations/presto.html
- /using/presto.html
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Python
description: Use Python to interact with your objects on lakeFS
parent: Integrations
has_children: false
redirect_from:
- /using/python.html
- /using/boto.html
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/r.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: R
description: How to use lakeFS from R including creating branches, committing changes, and merging.
parent: Integrations
has_children: false
---

# Using R with lakeFS
Expand Down
1 change: 0 additions & 1 deletion docs/integrations/sagemaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Amazon SageMaker
description: This section explains how to integrate your Amazon SageMaker installation to work with lakeFS.
parent: Integrations
has_children: false
redirect_from: /using/sagemaker.html
---

Expand Down
1 change: 0 additions & 1 deletion docs/integrations/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Apache Spark
description: Accessing data in lakeFS from Apache Spark works the same as accessing S3 data from Apache Spark.
parent: Integrations
has_children: false
redirect_from:
- /integrations/databricks.html
- /integrations/emr.html
Expand Down
1 change: 0 additions & 1 deletion docs/posts/security_update.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
parent: posts
has_children: false
date: 2023-01-31
search_exclude: true
---
Expand Down
1 change: 0 additions & 1 deletion docs/project/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
has_children: false
redirect_from:
- /contributing.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/project/docs/callouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Callouts
description: Using and Customising Callouts in lakeFS Documentation
parent: Documentation
grand_parent: The lakeFS Project
has_children: false
redirect_from:
- /callouts.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/actions-and-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 6️⃣ Using Actions and Hooks in lakeFS
description: lakeFS quickstart / Use Actions and Hooks to enforce conditions when committing and merging changes
parent: ⭐ Quickstart ⭐
nav_order: 30
has_children: false
next: ["Resources for learning more about lakeFS", "./learning-more-lakefs.html"]
previous: ["Rollback the changes", "./rollback.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 3️⃣ Create a branch
description: lakeFS quickstart / Create a branch in lakeFS without copying data on disk, make a change to the branch, see that the original version of the data is unchanged.
parent: ⭐ Quickstart ⭐
nav_order: 15
has_children: false
next: ["Merge the branch back into main", "./commit-and-merge.html"]
previous: ["Query the pre-populated data", "./query.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/commit-and-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 4️⃣ Commit and Merge
description: lakeFS quickstart / Commit the change and merge it back into the main branhch
parent: ⭐ Quickstart ⭐
nav_order: 20
has_children: false
next: ["Rollback the changes", "./rollback.html"]
previous: ["Create a branch of the data", "./branch.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 1️⃣ Run lakeFS
description: lakeFS quickstart / Run lakeFS locally pre-populated with a sample repository and data under Docker Compose
parent: ⭐ Quickstart ⭐
nav_order: 5
has_children: false
next: ["Query the pre-populated data", "./query.html"]
previous: ["Quickstart introduction", "./index.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/learning-more-lakefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 🧑🏻‍🎓 Learn more about lakeFS
description: Learn more about lakeFS here with links to resources including quickstart, samples, installation guides, and more.
parent: ⭐ Quickstart ⭐
nav_order: 99
has_children: false
previous: ["Using Actions and Hooks in lakeFS", "./actions-and-hooks.html"]
---

Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 2️⃣ Query the data
description: lakeFS quickstart / Query the pre-populated data using DuckDB browser that's built into lakeFS
parent: ⭐ Quickstart ⭐
nav_order: 10
has_children: false
next: ["Create a branch of the data", "./branch.html"]
previous: ["Launch the quickstart environment", "./launch.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/quickstart/rollback.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 5️⃣ Roll back Changes
description: lakeFS quickstart / Rollback the changes made to show how lakeFS can be used to revert changes made in error.
parent: ⭐ Quickstart ⭐
nav_order: 25
has_children: false
next: ["Using Actions and Hooks in lakeFS", "./actions-and-hooks.html"]
previous: ["Merge the branch back into main", "./commit-and-merge.html"]
---
Expand Down
1 change: 0 additions & 1 deletion docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: lakeFS API
description: This section includes the reference documentation for the lakeFS platform's various APIs.
parent: Reference
has_children: false
---

{% include swagger.html %}
1 change: 0 additions & 1 deletion docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
has_children: false
redirect_from:
- /reference/commands.html
---
Expand Down
1 change: 0 additions & 1 deletion docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: lakeFS Server Configuration
description: Configuration reference for lakeFS Server
parent: Reference
has_children: false
---

# lakeFS Server Configuration
Expand Down
1 change: 0 additions & 1 deletion docs/reference/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Monitoring using Prometheus
description: A guide to monitoring your lakeFS Installation with Prometheus.
parent: Reference
has_children: false
redirect_from: /deploying-aws/monitor.md
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: S3 Gateway API
description: "S3 Gateway API. lakeFS supports the following API operations: Identity and authorization, Bucket operations, Object operations and listing"
parent: Reference
has_children: false
---
# S3-Supported API

Expand Down
1 change: 0 additions & 1 deletion docs/reference/spark-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Spark Client
description: The lakeFS Spark client performs operations on lakeFS committed metadata stored in the object store.
parent: Reference
has_children: false
---


Expand Down
1 change: 0 additions & 1 deletion docs/slack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Slack
nav_order: 100
description: Redirect page for lakeFS slack joining url
has_children: false
nav_exclude: true
redirect_to: "https://lakefs.io/slack"
---
Expand Down
Loading

0 comments on commit 9c4005c

Please sign in to comment.