Skip to content

Commit

Permalink
docs: restructure getting started (#1749)
Browse files Browse the repository at this point in the history
* Restructure getting started section of docs

* Use root relative paths

* retention
  • Loading branch information
danthelion authored Nov 1, 2024
1 parent 3e059d1 commit 426055a
Show file tree
Hide file tree
Showing 49 changed files with 411 additions and 308 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![CI](https://github.com/estuary/flow/workflows/CI/badge.svg)](https://github.com/estuary/flow/actions)
[![Slack](https://img.shields.io/badge/slack-@gazette/dev-yellow.svg?logo=slack)](https://join.slack.com/t/gazette-dev/shared_invite/enQtNjQxMzgyNTEzNzk1LTU0ZjZlZmY5ODdkOTEzZDQzZWU5OTk3ZTgyNjY1ZDE1M2U1ZTViMWQxMThiMjU1N2MwOTlhMmVjYjEzMjEwMGQ) | **[Docs home](https://docs.estuary.dev/)** | **[Free account](https://go.estuary.dev/sign-up)** | **[Data platform comparison reference](https://docs.estuary.dev/overview/comparisons)** | **[Email list](https://www.estuary.dev/newsletter-signup/)**
[![Slack](https://img.shields.io/badge/slack-@gazette/dev-yellow.svg?logo=slack)](https://join.slack.com/t/gazette-dev/shared_invite/enQtNjQxMzgyNTEzNzk1LTU0ZjZlZmY5ODdkOTEzZDQzZWU5OTk3ZTgyNjY1ZDE1M2U1ZTViMWQxMThiMjU1N2MwOTlhMmVjYjEzMjEwMGQ) | **[Docs home](https://docs.estuary.dev/)** | **[Free account](https://go.estuary.dev/sign-up)** | **[Data platform comparison reference](https://docs.estuary.dev/getting-started/comparisons)** | **[Email list](https://www.estuary.dev/newsletter-signup/)**

<p align="center">
<img src ="site/static/img/estuary-new.png"
Expand Down
4 changes: 2 additions & 2 deletions site/docs/concepts/storage-mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Flow stores the documents that comprise your collections in a cloud storage buck
Your **storage mapping** tells Flow which bucket to use.

When you first register for Flow, your storage mapping is Estuary's secure Google Cloud Storage bucket.
Data in Flow's cloud storage bucket is deleted 30 days after collection.
Data in Flow's cloud storage bucket is deleted 20 days after collection.

For production workflows, you should [set up your own cloud storage bucket as a storage mapping](../getting-started/installation.mdx#configuring-your-cloud-storage-bucket-for-use-with-flow).
For production workflows, you should [set up your own cloud storage bucket as a storage mapping](../guides/configure-cloud-storage.md).

You may also use apply different storage mappings to different [catalog prefixes](./catalogs.md#namespace) within your organization's prefix.

Expand Down
Binary file removed site/docs/getting-started/Azure_AD_Tenant_ID.png
Binary file not shown.
Binary file removed site/docs/getting-started/Azure_Container_ID.png
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion site/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Get started",
"label": "Getting Started",
"position": 2
}
File renamed without changes.
2 changes: 1 addition & 1 deletion site/docs/getting-started/deployment-options.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: deployment-options
title: Deployment Options
title: Deployment options
sidebar_position: 2
---

Expand Down
55 changes: 55 additions & 0 deletions site/docs/getting-started/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_position: 1
description: Get to know Estuary Flow and learn how to get started.
slug: /
---

# What is Estuary Flow?

Estuary Flow is a unified data movement and transformation platform for the whole data team.

Flow synchronizes your systems – SaaS, databases, streaming, and more – around the same datasets, which it stores in the
cloud and updates in milliseconds. It combines the easy cross-system integration of an ELT tool and a flexible streaming
backbone, all while remaining aware of your data's complete history.

A few examples of what you can do with Flow:

* Perform *change data capture* from MySQL tables into PostgreSQL or a cloud analytics warehouse like Snowflake or
Databricks
* Capture and organize your data from your SaaS vendors (like Hubspot or Facebook), into an Apache Iceberg lakehouse
* Fetch, transform, and load logs from cloud delivery networks (CDNs) into Elasticsearch or BigQuery
* Hydrate real-time analytics systems such as Tinybird or StarTree
* Instrument real-time analytics over your business events, accessible from current tools like PostgreSQL or even Google
Sheets

Under the hood, Flow comprises cloud-native streaming infrastructure, a powerful runtime for data processing,
and an open-source ecosystem of pluggable connectors for integrating your existing data systems.

## Get started with Flow

To start using Flow for free, visit the [dashboard](https://go.estuary.dev/dashboard) and register for free.

Start using Flow with these recommended resources.

- **[Quickstart](quickstart/quickstart.md)**: Take a look at the Quickstart to see how easy it is to set up a real-time
data flow.

- **[User guides](../guides/README.md)**: Get familiar with Flow concepts by reading these byte-sized user guides.

- **[Tutorials](tutorials/README.md)**: Check out some of our step-by-step tutorials where we show you how to set up
complete data flows.

- **[High level concepts](../concepts/README.md)**: Start here to learn more about important Flow terms.

## Watch the videos

- **[Change Data Capture for PostgreSQL](https://www.youtube.com/watch?v=9Bpj6k4H_0c)**
- **[PostgreSQL to Apache Iceberg - Streaming Lakehouse Foundations](https://www.youtube.com/watch?v=vzCkb-bOpxs)**
- **[Real-time CDC with MongoDB](https://www.youtube.com/watch?v=kpF-YCxtArk)**

## **Other resources**

- Our [website](https://www.estuary.dev) offers general information about Flow, Estuary, and how we fit into the data
infrastructure landscape.
- Our source code lives on [GitHub](https://github.com/estuary).

207 changes: 0 additions & 207 deletions site/docs/getting-started/installation.mdx

This file was deleted.

4 changes: 4 additions & 0 deletions site/docs/getting-started/quickstart/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Quickstart for Flow",
"position": 1
}
Loading

0 comments on commit 426055a

Please sign in to comment.