Skip to content

Docs: infer navigation hierarchy from filesystem #9151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion cmd/lakectl/cmd/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
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
redirect_from:
- /reference/commands.html
- /quickstart/lakefs_cli.html
Expand Down
360 changes: 273 additions & 87 deletions docs/_includes/nav.html

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/enterprise/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Architecture
description: lakeFS Enterprise architecture explained
nav_order: 220
parent: lakeFS Enterprise
---


Expand Down
1 change: 0 additions & 1 deletion docs/enterprise/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Configuration Reference
description: a configuration reference for lakeFS Enterprise
nav_order: 215
parent: lakeFS Enterprise
---

# lakeFS Enterprise Configuration Reference
Expand Down
2 changes: 0 additions & 2 deletions docs/enterprise/getstarted/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Get Started
description: Methods for getting started with lakeFS Enterprise
parent: lakeFS Enterprise
has_children: true
has_toc: false
nav_order: 200
---
Expand Down
2 changes: 0 additions & 2 deletions docs/enterprise/getstarted/install.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Install
description: lakeFS Enterprise Installation Guide
parent: Get Started
grand_parent: lakeFS Enterprise
nav_order: 202
---

Expand Down
2 changes: 0 additions & 2 deletions docs/enterprise/getstarted/migrate-from-oss.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Migrate from lakeFS OSS
description: How to migrate from lakeFS OSS to lakeFS Enterprise
parent: Get Started
grand_parent: lakeFS Enterprise
nav_order: 203
---

Expand Down
2 changes: 0 additions & 2 deletions docs/enterprise/getstarted/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Quickstart
description: Quickstart guides for lakeFS Enterprise
parent: Get Started
grand_parent: lakeFS Enterprise
nav_order: 201
---

Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: lakeFS Enterprise
description: lakeFS Enterprise is an enterprise-ready lakeFS solution providing additional features including RBAC, SSO and Support SLA.
has_children: true
description: lakeFS Enterprise is an enterprise-ready lakeFS solution providing additional
features including RBAC, SSO and Support SLA.
has_toc: false
nav_order: 110
---
Expand Down
1 change: 0 additions & 1 deletion docs/enterprise/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Troubleshooting lakeFS Enterprise
description: Guidance on troubleshooting a lakeFS Enterprise deployment
nav_order: 210
parent: lakeFS Enterprise
---

# Troubleshooting lakeFS Enterprise
Expand Down
1 change: 0 additions & 1 deletion docs/enterprise/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Upgrade
description: How to upgrade lakeFS Enterprise
nav_order: 205
parent: lakeFS Enterprise
---

# Upgrade
Expand Down
4 changes: 2 additions & 2 deletions docs/experimental/lakectl_local_posix.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: lakectl local file permissions tracking
description: An experimental feature that allows tracking file ownership and permissions when using lakectl local
parent: none
description: An experimental feature that allows tracking file ownership and permissions
when using lakectl local
---

# lakectl local file permission tracking
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/backup-and-restore.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup and Restore Repository
description: Use the lakeFS DumpRefs and RestoreRefs commands to backup and restore lakeFS repository
parent: How-To
description: Use the lakeFS DumpRefs and RestoreRefs commands to backup and restore
lakeFS repository
---

# Backup and Restore Repository
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/catalog_exports.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Data Catalogs Exports
description: This section explains how lakeFS can integrate with external Data Catalogs via metastore update operations.
parent: How-To
description: This section explains how lakeFS can integrate with external Data Catalogs
via metastore update operations.
---

# Data Catalogs Export
Expand Down
9 changes: 4 additions & 5 deletions docs/howto/copying.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: Copying data to/from lakeFS
description:
parent: How-To
redirect_from:
- /integrations/distcp.html
- /integrations/rclone.html
description:
redirect_from:
- "/integrations/distcp.html"
- "/integrations/rclone.html"
---

# Copying data to/from lakeFS
Expand Down
21 changes: 11 additions & 10 deletions docs/howto/deploy/aws.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: AWS
grand_parent: How-To
parent: Install lakeFS
description: How to deploy and set up a production-suitable lakeFS environment on AWS
description: How to deploy and set up a production-suitable lakeFS environment on
AWS
redirect_from:
- /deploying-aws/index.html
- /deploying-aws/install.html
- /deploying-aws/db.html
- /deploying-aws/lb_dns.html
- /setup/storage/s3.html
- /deploy/aws.html
next: ["Import data into your installation", "/howto/import.html"]
- "/deploying-aws/index.html"
- "/deploying-aws/install.html"
- "/deploying-aws/db.html"
- "/deploying-aws/lb_dns.html"
- "/setup/storage/s3.html"
- "/deploy/aws.html"
next:
- Import data into your installation
- "/howto/import.html"
---

# Deploy lakeFS on AWS
Expand Down
13 changes: 7 additions & 6 deletions docs/howto/deploy/azure.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: Azure
grand_parent: How-To
parent: Install lakeFS
description: How to deploy and set up a production-suitable lakeFS environment on Microsoft Azure
description: How to deploy and set up a production-suitable lakeFS environment on
Microsoft Azure
redirect_from:
- /setup/storage/blob.html
- /deploy/azure.html
next: ["Import data into your installation", "/howto/import.html"]
- "/setup/storage/blob.html"
- "/deploy/azure.html"
next:
- Import data into your installation
- "/howto/import.html"
---

# Deploy lakeFS on Azure
Expand Down
13 changes: 7 additions & 6 deletions docs/howto/deploy/gcp.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: GCP
grand_parent: How-To
parent: Install lakeFS
description: How to deploy and set up a production-suitable lakeFS environment on Google Cloud Platform (GCP).
description: How to deploy and set up a production-suitable lakeFS environment on
Google Cloud Platform (GCP).
redirect_from:
- /setup/storage/gcs.html
- /deploy/gcp.html
next: ["Import data into your installation", "/howto/import.html"]
- "/setup/storage/gcs.html"
- "/deploy/gcp.html"
next:
- Import data into your installation
- "/howto/import.html"
---

# Deploy lakeFS on GCP
Expand Down
15 changes: 7 additions & 8 deletions docs/howto/deploy/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: Install lakeFS
parent: How-To
description: This section will guide you through deploying and setting up a production lakeFS environment.
has_children: true
description: This section will guide you through deploying and setting up a production
lakeFS environment.
has_toc: false
nav_order: 1
redirect_from:
- /setup/
- /setup/storage/index.html
- /setup/create-repo.html
- /deploy/
- /deploy/index.html
- "/setup/"
- "/setup/storage/index.html"
- "/setup/create-repo.html"
- "/deploy/"
- "/deploy/index.html"
---

# Deploy and Setup lakeFS
Expand Down
21 changes: 11 additions & 10 deletions docs/howto/deploy/onprem.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: On-Premises
grand_parent: How-To
parent: Install lakeFS
description: How to deploy and set up a production-suitable lakeFS environment on-premises (or on other cloud providers)
description: How to deploy and set up a production-suitable lakeFS environment on-premises
(or on other cloud providers)
redirect_from:
- /deploy/k8s.html
- /deploy/docker.html
- /integrations/minio.html
- /using/minio.html
- /deploy/onprem.html
- /deploying/install.html
next: ["Import data into your installation", "/howto/import.html"]
- "/deploy/k8s.html"
- "/deploy/docker.html"
- "/integrations/minio.html"
- "/using/minio.html"
- "/deploy/onprem.html"
- "/deploying/install.html"
next:
- Import data into your installation
- "/howto/import.html"
---

# On-Premises Deployment
Expand Down
10 changes: 4 additions & 6 deletions docs/howto/deploy/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Upgrade lakeFS
description: How to upgrade lakeFS to the latest version.
grand_parent: How-To
parent: Install lakeFS
redirect_from:
- /deploying-aws/upgrade.html
- /reference/upgrade.html
- /howto/upgrade.html
redirect_from:
- "/deploying-aws/upgrade.html"
- "/reference/upgrade.html"
- "/howto/upgrade.html"
---

# Upgrading lakeFS
Expand Down
8 changes: 4 additions & 4 deletions docs/howto/export.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
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
redirect_from:
- /reference/export.html
description: Use the lakeFS Spark client or RClone inside Docker to export a lakeFS
commit to the object store.
redirect_from:
- "/reference/export.html"
---

# Exporting Data
Expand Down
18 changes: 8 additions & 10 deletions docs/howto/garbage-collection/gc.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
title: Garbage Collection
description: Clean up expired objects using the garbage collection feature in lakeFS.
parent: Garbage Collection
grand_parent: How-To
nav_order: 1
redirect_from:
- /howto/garbage-collection/index.html
- /howto/garbage-collection/committed.html
- /howto/garbage-collection/uncommitted.html
- /howto/garbage-collection/internals.html
- /reference/garbage-collection.html
- /howto/garbage-collection-index.html
- /howto/garbage-collection.html
- /reference/retention.html
- "/howto/garbage-collection/index.html"
- "/howto/garbage-collection/committed.html"
- "/howto/garbage-collection/uncommitted.html"
- "/howto/garbage-collection/internals.html"
- "/reference/garbage-collection.html"
- "/howto/garbage-collection-index.html"
- "/howto/garbage-collection.html"
- "/reference/retention.html"
---

# Garbage Collection
Expand Down
2 changes: 0 additions & 2 deletions docs/howto/garbage-collection/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Garbage Collection
description: Clean up expired objects using the garbage collection feature in lakeFS.
parent: How-To
has_children: true
---
[lakeFS Cloud](https://lakefs.cloud) users enjoy a [managed garbage collection]({% link howto/garbage-collection/managed-gc.md %}) service, and do not need to run this Spark program.
7 changes: 3 additions & 4 deletions docs/howto/garbage-collection/managed-gc.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: Managed Garbage Collection
description: Reduce the operational overhead of running garbage collection manually.
parent: Garbage Collection
nav_order: 5
grand_parent: How-To
badges: ["Enterprise"]
badges:
- Enterprise
redirect_from:
- /cloud/managed-gc.html
- "/cloud/managed-gc.html"
---

# Managed Garbage Collection
Expand Down
7 changes: 3 additions & 4 deletions docs/howto/garbage-collection/standalone-gc.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: Standalone Garbage Collection
description: Run a limited version of garbage collection without any external dependencies
parent: Garbage Collection
nav_order: 5
grand_parent: How-To
badges: ["Enterprise"]
badges:
- Enterprise
redirect_from:
- /cloud/standalone-gc.html
- "/cloud/standalone-gc.html"
---

# Standalone Garbage Collection
Expand Down
4 changes: 1 addition & 3 deletions docs/howto/hooks/airflow.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Airflow Hooks
parent: Actions and Hooks
grand_parent: How-To
description: Airflow Hooks Reference
redirect_from:
- /hooks/airflow.html
- "/hooks/airflow.html"
---

# Airflow Hooks
Expand Down
14 changes: 6 additions & 8 deletions docs/howto/hooks/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Actions and Hooks
description: Overview of lakeFS Actions and Hooks
has_children: true
has_toc: false
parent: How-To
nav_order: 3
redirect_from:
- /reference/hooks.html
- /hooks.html
- /hooks/overview.html
- /hooks/index.html
- /hooks/
- /setup/hooks.html
- "/reference/hooks.html"
- "/hooks.html"
- "/hooks/overview.html"
- "/hooks/index.html"
- "/hooks/"
- "/setup/hooks.html"
---

# Actions and Hooks in lakeFS
Expand Down
6 changes: 2 additions & 4 deletions docs/howto/hooks/lua.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Lua Hooks
parent: Actions and Hooks
grand_parent: How-To
description: Lua Hooks reference
description: Lua Hooks reference
redirect_from:
- /hooks/lua.html
- "/hooks/lua.html"
---


Expand Down
Loading
Loading