Merge pull request #5 from treeverse/master

pull latest
treeverse · Nov 27, 2020 · 1e5b8ee · 1e5b8ee
2 parents fb4ad3d + 6c42896
commit 1e5b8ee
Show file tree

Hide file tree

Showing 50 changed files with 63 additions and 11 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Architecture
+description: lakeFS architecture overview. Learn more about lakeFS components, including its S3 API gateway.
 nav_order: 7
 has_children: false
 ---

diff --git a/docs/branching/index.md b/docs/branching/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Branching Model
+description: At its core, lakeFS uses a Git-like branching model that scales to Petabytes of data by utilizing S3 or GCS for storage.
 nav_order: 3
 has_children: true
 ---
diff --git a/docs/branching/model.md b/docs/branching/model.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Introduction
+description: When creating a new branch in lakeFS, we are actually creating a consistent snapshot of the entire repository
 parent: Branching Model
 has_children: false
 nav_order: 1

diff --git a/docs/branching/recommendations.md b/docs/branching/recommendations.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Recommended Branching Models
+description: The brnaching modles listed below are often used to help improve organization's data developmet and CI/CD 
 parent: Branching Model
 has_children: false
 nav_order: 2

diff --git a/docs/community.md b/docs/community.md
@@ -1,20 +1,29 @@
 ---
 layout: default
 title: Community
+description: lakeFS community. Join the community on the lakeFS slack channel and feel free to ask questions and get help.
 nav_order: 10
 has_children: false
 ---
 
 # Community
 
-### DockerHub
+We're excited to hear from you!
 
-lakeFS and lakectl are both available as Docker images on the [Treeverse Docker Hub page](https://hub.docker.com/u/treeverse/).
+### Get in touch with the lakeFS team
+
+Join our public slack [channel](https://join.slack.com/t/lakefs/shared_invite/zt-g86mkroy-186GzaxR4xOar1i1Us0bzw). We’re extremely responsive and you can expect a fast reply.
+
+### Contribute
+
+Whether it’s a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community. Our [Contributing Guide](https://docs.lakefs.io/contributing.html) is a great place to get started. 
 
-### Support
+### Ask a question
 
-Feedback and questions are welcome at [support@treeverse.io](mailto:support@treeverse.io).
+If you have any questions or need technical support, feel free to message us in the [slack](https://join.slack.com/t/lakefs/shared_invite/zt-g86mkroy-186GzaxR4xOar1i1Us0bzw)#help channel. 
+
+### DockerHub
+
+lakeFS and lakectl are both available as Docker images on the [Treeverse Docker Hub page](https://hub.docker.com/u/treeverse/).
 
-### Slack Channel
 
-Join our [channel](https://join.slack.com/t/lakefs/shared_invite/zt-g86mkroy-186GzaxR4xOar1i1Us0bzw) to get help from our team and other users
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Contributing
+description: lakeFS community welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide.
 nav_order: 10
 has_children: false
 ---

diff --git a/docs/deploying/bucket.md b/docs/deploying/bucket.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Configuring the S3 bucket
+description: For information on configuring the S3 bucket to provide the data storage layer for our installation. 
 parent: AWS Deployment
 nav_order: 15
 has_children: false

diff --git a/docs/deploying/db.md b/docs/deploying/db.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Creating the database
+description: Creating the database. Before installing lakeFS, you need to have a PostgreSQL database.
 parent: AWS Deployment
 nav_order: 10
 has_children: false

diff --git a/docs/deploying/index.md b/docs/deploying/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: AWS Deployment
+description: This section will guide you through deploying your lakeFS environment.
 nav_order: 1
 has_children: true
 ---

diff --git a/docs/deploying/install.md b/docs/deploying/install.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Installing lakeFS
+description: Installing lakeFS is easy. This section covers commom deployment options for installing lakeFS.
 parent: AWS Deployment
 nav_order: 20
 has_children: false

diff --git a/docs/deploying/lb_dns.md b/docs/deploying/lb_dns.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Load Balancing and DNS
+description: Depending on how you chose to install lakeFS, you should have a load balancer direct requests to the lakeFS server.
 parent: AWS Deployment
 nav_order: 25
 has_children: false

diff --git a/docs/deploying/monitor.md b/docs/deploying/monitor.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Monitoring using Prometheus
+description: Users looking to monitor their lakeFS instances can point Prometheus configuration to scrape data from this endpoint. This guide explains how to setup
 parent: AWS Deployment
 nav_order: 30
 has_children: false

diff --git a/docs/deploying/offboarding.md b/docs/deploying/offboarding.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Migrating away from lakeFS
+description: The simplest way to migrate away from lakeFS is to copy data from a lakeFS repository to an S3 bucket
 parent: AWS Deployment
 nav_order: 40
 has_children: false

diff --git a/docs/deploying/setup.md b/docs/deploying/setup.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Setup
+description: This section outlines how to setup your environment once lakeFS is configured and running
 parent: AWS Deployment
 nav_order: 27
 has_children: false

diff --git a/docs/deploying/upgrade.md b/docs/deploying/upgrade.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Upgrade lakeFS
+description: Upgrading lakeFS from a previous version usually just requires re-deploying with the latest image or downloading the latest version
 parent: AWS Deployment
 nav_order: 50
 has_children: false

diff --git a/docs/downloads.md b/docs/downloads.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Downloads
+description: This section provides information on downloads of binary packeges and official docker images.
 nav_order: 3
 has_children: false
 ---

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: FAQ
+description: Frequently Asked Questions (FAQ). Have a question about lakeFS? Find our what others where asking
 nav_order: 11
 has_children: false
 ---

diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: What is lakeFS
+description: A lakeFS documentation website that provides information on how to use lakeFS to deliver resilience and manageability to data lakes.
 nav_order: 0
 ---
 

diff --git a/docs/licensing.md b/docs/licensing.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Licensing
+description: lakeFS is an open source project under the Apache 2.0 license. As a commercial organization, we intend to use an open core model.
 nav_order: 13
 has_children: false
 ---

diff --git a/docs/quickstart/aws_cli.md b/docs/quickstart/aws_cli.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Copy Files
+description: In this section we will learn how to configure and use AWS CLI to manage data with the lakeFS Server.
 parent: Quick Start
 nav_order: 30
 has_children: false

diff --git a/docs/quickstart/index.md b/docs/quickstart/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Quick Start
+description: The quickstart. This section provides simple instructions for deploying lakeFS so that you start exploring the technology
 nav_order: 1
 has_children: true
 redirect_from: "../quickstart.html"

diff --git a/docs/quickstart/installing.md b/docs/quickstart/installing.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Install lakeFS
+description: Installing lakeFS is easy. This section covers how to install lakeFS using docker compose.
 parent: Quick Start
 nav_order: 10
 has_children: false

diff --git a/docs/quickstart/more_quickstart_options.md b/docs/quickstart/more_quickstart_options.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: More Quickstart Options
+description: Quickstart options. This section outlines additional quickstart options to deploying lakeFS.
 parent: Quick Start
 nav_order: 50
 has_children: false

diff --git a/docs/quickstart/repository.md b/docs/quickstart/repository.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Create Repository
+description: In this guide, we’re going to run an initial setup and then create a new repository using lakeFS.
 parent: Quick Start
 nav_order: 20
 has_children: false

diff --git a/docs/quickstart/try.md b/docs/quickstart/try.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Try without installing
+description: Learn how to use lakeFS using the CLI and an interactive Spark shell - all from your browser, without installing anything
 parent: Quick Start
 nav_order: 99
 has_children: false

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

diff --git a/docs/reference/authorization.md b/docs/reference/authorization.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Authentication & Authorization
+description: This section covers authorization (using AWS IAM) and Authentication of your lakeFS server. 
 parent: Reference
 nav_order: 4
 has_children: false

diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Command (CLI) Reference
+description: lakeFS comes with its own native CLI client. Here you can see the complete command reference.
 parent: Reference
 nav_order: 3
 has_children: false

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Configuration Reference
+description: Configuring lakeFS is done using a yaml configuration file. This reference uses . to denote the nesting of values.
 parent: Reference
 nav_order: 2
 has_children: false

diff --git a/docs/reference/import.md b/docs/reference/import.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Importing data from S3
+description: In order to import existing data to lakeFS, you may choose to copy it using S3 CLI or using tools like Apache DistCp.
 parent: Reference
 nav_order: 8
 has_children: false

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Reference
+description: This section includes the reference documentation for the lakeFS platform's various APIs, CLIs, and file formats.
 nav_order: 5
 has_children: true
 ---
diff --git a/docs/reference/retention.md b/docs/reference/retention.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Object Retention
+description: LakeFS allows configuration of object retention policies using a lifecycle configuration. 
 parent: Reference
 nav_order: 10
 has_children: false

diff --git a/docs/reference/s3.md b/docs/reference/s3.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: S3 Supported API
+description: "S3 Supported API. lakeFS supports the following API operations: Identity and authorization, Bucket operations, Object operations and listing"
 parent: Reference
 nav_order: 1
 has_children: false

diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Roadmap
+description: New features and improvements are lined up next for lakeFS. We would love you to be part of building lakeFS’s roadmap.
 nav_order: 8
 has_children: false
 ---

diff --git a/docs/using/airflow.md b/docs/using/airflow.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Airflow
+description: Querying data in lakeFS from Presto is the same as querying data in S3 from Presto. It is done using the Hive connector.
 parent: Using lakeFS with...
 nav_order: 10
 has_children: false

diff --git a/docs/using/athena.md b/docs/using/athena.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Amazon Athena
+description: This section covers how you can start using lakeFS with Amazon Athena, a serverless, interactive query service in Amazon S3
 parent: Using lakeFS with...
 nav_order: 9
 has_children: false
@@ -19,4 +20,3 @@ create-symlink receives a table in glue pointing to lakeFS and creates a copy of
 We can then query the new created table with Athena
 
 
-
diff --git a/docs/using/aws_cli.md b/docs/using/aws_cli.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: AWS CLI
+description: This section covers how to use the file commands (CLI) for S3 to access lakeFS
 parent: Using lakeFS with...
 nav_order: 2
 has_children: false

diff --git a/docs/using/boto.md b/docs/using/boto.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Boto (Python)
+description: This section covers how you can start using lakeFS with Boto (Python), the AWS SDK for Python.
 parent: Using lakeFS with...
 nav_order: 8
 has_children: false

diff --git a/docs/using/distcp.md b/docs/using/distcp.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Copying Data with DistCp
+description: Apache Hadoop DistCp is a tool used for large inter/intra-cluster copying. You can easily use it with your lakeFS repositories.
 parent: Using lakeFS with...
 nav_order: 0
 has_children: false

diff --git a/docs/using/emr.md b/docs/using/emr.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: EMR
+description: This section covers how you can start using lakeFS with EMR, an AWS service that uses open-source frameworks to process vast amounts of data.
 parent: Using lakeFS with...
 nav_order: 6
 has_children: false

diff --git a/docs/using/glue_hive_metastore.md b/docs/using/glue_hive_metastore.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Glue / Hive metastore 
+description: When working with Glue or Hive metastore, each table can point only to one lakeFS branch. 
 parent: Using lakeFS with...
 nav_order: 11
 has_children: false

diff --git a/docs/using/hive.md b/docs/using/hive.md
@@ -1,6 +1,7 @@
 ---
 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: Using lakeFS with...
 nav_order: 4
 has_children: false

diff --git a/docs/using/index.md b/docs/using/index.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Using lakeFS with...
+description: You can use lakeFS with all modern data frameworks such as Spark, Hive, AWS Athena, Presto, etc.
 nav_order: 6
 has_children: true
 ---
diff --git a/docs/using/kakfa.md b/docs/using/kakfa.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Kafka
+description: This section covers how you can start using lakeFS with Kafka using Confluent’s S3 Sink Connector
 parent: Using lakeFS with...
 nav_order: 12
 has_children: false

diff --git a/docs/using/mapreduce.md b/docs/using/mapreduce.md
@@ -1,6 +1,7 @@
 ---
 layout: default
 title: MapReduce
+description: This section covers how you can start using lakeFS with MapReduce, a program model for distributed computing based on java.
 parent: Using lakeFS with...
 nav_order: 13
 has_children: false