Skip to content

Commit

Permalink
Merge pull request #548 from keboola/update-documentation-1
Browse files Browse the repository at this point in the history
Update documentation 1
  • Loading branch information
hhanova authored Dec 22, 2023
2 parents 64f3c65 + 0dca1f7 commit 6bb762d
Show file tree
Hide file tree
Showing 209 changed files with 1,941 additions and 981 deletions.
38 changes: 26 additions & 12 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,51 @@ items:
- url: /tutorial/
title: Getting Started Tutorial
items:
- url: /tutorial/onboarding/
title: Keboola Platform Onboarding
items:
- url: /tutorial/onboarding/usage-blueprint/
title: Usage Blueprint

- url: /tutorial/onboarding/architecture-guide/
title: Multi-Project Architecture
items:
- url: /tutorial/onboarding/architecture-guide/bdm-guide/
title: Business Data Model

- url: /tutorial/onboarding/cheat-sheet/
title: Best Practices

- url: /tutorial/onboarding/governance-guide/
title: Governance Guide

- url: /tutorial/load/
title: Part 1 - Loading Data
items:
- url: /tutorial/load/googledrive/
title: Loading with GoogleDrive Extractor
- url: /tutorial/load/googlesheets/
title: Loading with Google Sheets Data Source

- url: /tutorial/load/database/
title: Loading with Database Extractor
title: Loading with Database Data Source

- url: /tutorial/manipulate/
title: Part 2 - Data Manipulation
items:
- url: /tutorial/manipulate/sandbox/
title: Using Sandbox
- url: /tutorial/manipulate/workspace/
title: Using Workspace

- url: /tutorial/write/
title: Part 3 - Writing Data
items:
- url: /tutorial/write/gooddata/
title: Writing to GoodData

- url: /tutorial/automate/
title: Part 4 - Automation
title: Part 4 - Flow Automation

- url: /tutorial/ad-hoc/
title: Part 5 - Ad-Hoc Data Analysis

- url: /tutorial/branches/
title: Part 6 - Development Branches
items:

- url: /tutorial/branches/prepare-tables/
title: Prepare Tables

Expand All @@ -61,7 +75,7 @@ items:
title: Components
items:
- url: /components/extractors/
title: Extractors
title: Data Source Connectors
items:
- url: /components/extractors/communication/
title: Communication
Expand Down Expand Up @@ -301,7 +315,7 @@ items:
title: YourPass

- url: /components/writers/
title: Writers
title: Data Destination Connectors
items:
- url: /components/writers/bi-tools/
title: Business Intelligence
Expand Down
36 changes: 18 additions & 18 deletions components/extractors/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Extractors
title: Data Source Connectors
permalink: /components/extractors/
redirect_from:
- /extractors/
Expand All @@ -9,38 +9,38 @@ redirect_from:
* TOC
{:toc}

Extractors are [Keboola Connection components](/components/) used for **importing data from external sources into Keboola Connection**.
Data source connectors (formerly known as Extractors) are [Keboola components](/components/) used for **importing data from external sources into Keboola**.

## Types of Extractors
Typically, extractors connect to [APIs](https://en.wikipedia.org/wiki/Application_programming_interface#Web_APIs)
external services, like Facebook, Youtube, Gmail and so on.
## Types of Data Source Connectors
Typically, data source connectors connect to [APIs](https://en.wikipedia.org/wiki/Application_programming_interface#Web_APIs)
external services, like Facebook, YouTube, Gmail and so on.
They can also connect directly to an arbitrary database.

Extractors can be grouped by their primary purpose:
They can be grouped by their primary purpose:

- Database extractors: [SQL Databases](/components/extractors/database/sqldb/) and [NoSQL MongoDB](/components/extractors/database/mongodb/) and extractors from generic [Storage services](/components/extractors/storage/)
- Database data source connectors: [SQL Databases](/components/extractors/database/sqldb/) and [NoSQL MongoDB](/components/extractors/database/mongodb/) and data source connectors from generic [Storage services](/components/extractors/storage/)
- [Communication](/components/extractors/communication/),
[Social Networks](/components/extractors/social/) and [Marketing and Sales](/components/extractors/marketing-sales/) extractors
- [Other](/components/extractors/other/) extractors such as Geocoding-Augmentation or Weather Forecast
[Social Networks](/components/extractors/social/) and [Marketing and Sales](/components/extractors/marketing-sales/) data source connectors
- [Other](/components/extractors/other/) data source connectors, such as Geocoding-Augmentation or Weather Forecast

For a definitive list of usable extractors, see your project **Extractors** section or the
For a definitive list of usable data source connectors, see your project **Data Sources** section or the
[public list of components](https://components.keboola.com/components).

## Working with Extractors
Even though extractors are generally designed for [**automated and repeated**](/orchestrator/) data collection,
## Working with Data Source Connectors
Even though data source connectors are generally designed for [**automated and repeated**](/orchestrator/) data collection,
they can be triggered manually at any time.

- For manual import of ad-hoc data, see [Data Import in Storage](/storage/files/), or our [tutorial on manual data loading](/tutorial/load/).
- Configure a [sample extractor](/tutorial/load/googledrive/) (GoogleDrive).
- Configure a [Database extractor](/tutorial/load/database/);
other SQL database extractors are configured in the exact same way.
- Configure a [sample data source connector](/tutorial/load/googledrive/) (GoogleDrive).
- Configure a [database data source connector](/tutorial/load/database/);
other SQL database data source connectors are configured in the exact same way.

As bringing data into Keboola Connection is the main purpose of an extractor, go the path of least resistance:
As bringing data into Keboola is the main purpose of a data source connectors, go the path of least resistance:
**Get your data in first, and then convert it to what you want it to look like.**
To give an example, when connecting to existing information systems, do not modify the data in them.
Such data conversion can prove to be difficult and expensive. Extract what you need and shape it in Keboola Connection.
Such data conversion can prove to be difficult and expensive. Extract what you need and shape it in Keboola.

## Limitations
Some extractors have **limits inherent to their sources**. Unfortunately, there is not much we can do about it.
For example, the Twitter extractor will not let you access the history of a particular tweet account beyond a certain point
For example, the Twitter data source connectors will not let you access the history of a particular tweet account beyond a certain point
because of the [limitations](https://stackoverflow.com/questions/1662151/getting-historical-data-from-twitter) of Twitter API.
16 changes: 8 additions & 8 deletions components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ redirect_from:
* TOC
{:toc}

In the Keboola Connection platform, most of the data processing functions are implemented in **Components**.
In the Keboola platform, most of the data processing functions are implemented in **Components**.
Components are divided into the following categories:

- [**Data sources (extractors)**](/components/extractors/) – bring data into a Keboola Connection project.
- [**Data destinations (writers)**](/components/writers/) – send processed data into a target system.
- [**Data source connectors (extractors)**](/components/extractors/) – bring data into a Keboola project.
- [**Data destination connectors (writers)**](/components/writers/) – send processed data into a target system.
- [**Applications**](/components/applications/) – process complex data.

All components, regardless of their category, behave the same way. To use a component, you have to create a **configuration** first. A configuration is used to set the necessary parameters for each
Expand Down Expand Up @@ -73,7 +73,7 @@ To create a new component configuration, select *Components* from the top naviga
![Screenshot - Create Configuration](/components/configuration-1.png)

The following page lists the current configurations (e.g., extractors) in the project. To create a new configuration of a new component,
use the **Directory** or the **Add New Extractor** button.
use the **Directory** or the **Add New Data Source** button.

{: .image-popup}
![Screenshot - Extractors List](/components/configuration-2.png)
Expand Down Expand Up @@ -259,8 +259,8 @@ configuration.*
## Authorization
Many services support authorization using the [OAuth protocol](https://en.wikipedia.org/wiki/OAuth). For you (as the end user)
it means that the service does not require entering credentials (username, password, token, etc.). Instead you are
redirected to the service itself where you authorize the Keboola Connection component. Then you are redirected back to
Keboola Connection and you can set other parameters and run the configuration.
redirected to the service itself where you authorize the Keboola component. Then you are redirected back to
Keboola and you can set other parameters and run the configuration.

The OAuth authorization process begins with the **Authorize** button (in this example the
[Google calendar extractor](/components/extractors/communication/google-calendar/) is shown):
Expand All @@ -271,10 +271,10 @@ The OAuth authorization process begins with the **Authorize** button (in this ex
In the next step, you can choose the authorization method:

- **Instant**: Use this method if you have direct access to the account; the authorization will be done immediately.
- **External**: If you need to authorize access to the service from someone who does not have an account in Keboola Connection, you can generate an external link, which will guide them through this process.
- **External**: If you need to authorize access to the service from someone who does not have an account in Keboola, you can generate an external link, which will guide them through this process.

OAuth authorization is a very secure authorization method in which you don't have to hand over the
credentials to your account. The consumer -- Keboola Connection component -- obtains only the minimal required
credentials to your account. The consumer -- Keboola component -- obtains only the minimal required
access. The authorization is only valid for the configuration in which it was created and for its **copies**.

### Instant Authorization
Expand Down
20 changes: 10 additions & 10 deletions components/writers/index.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
---
title: Writers
title: Data Destination Connectors
permalink: /components/writers/
redirect_from:
- /writers/

---

Writers are [Keboola Connection components](/overview/) that take transformed and processed **output data from Keboola Connection**
Data destination connectors are [Keboola components](/overview/) that take transformed and processed **output data from Keboola**
and deliver it **into its final destination:** the systems and applications where the data gets used/**consumed**.

## Types of Writers
## Types of Data Destination Connectors
We integrate your data into most of the top market systems.
Choose the right consumption point for each project and use case. Like with Extractors,
Choose the right consumption point for each project and use case. Like with data source connectors,
there are **no limitations** to how and where you can send your data.

Writers can be grouped by their primary purpose:
Data destination connectors can be grouped by their primary purpose:

- **Business Intelligence**: [Tableau](/components/writers/bi-tools/tableau/), [GoodData](/components/writers/bi-tools/gooddata/), [Looker](/components/writers/bi-tools/looker/), and more
- **Databases**: [MySQL](/components/writers/database/mysql/), [Oracle](/components/writers/database/oracle/), [PostgreSQL](/components/writers/database/postgresql/), [Amazon Redshift](/components/writers/database/redshift/), [Snowflake](/components/writers/database/snowflake/), [Synapse](/components/writers/database/synapse/), and more
- **Generic Storage**: [AWS S3](/components/writers/storage/aws-s3/), [Dropbox](/components/writers/storage/dropbox/), [Google Drive](/components/writers/storage/google-drive/),
[Google Sheets](/components/writers/storage/google-sheets/), [Keboola Connection Storage](/components/writers/storage/storage-api/), and more
- [Other](/components/writers/other/) writers such as Azure Event Hub
- [Other](/components/writers/other/) data destination connectors such as Azure Event Hub

For a definitive list of usable writers, see your project **Writers** section.
For a definitive list of usable data destination connectors, see your project **Data Destinations** section.

## Working with Writers
Each writer can have multiple configurations. Each configuration usually represents a single destination (database account, BI project, etc.).
Even though writers are generally designed for [**automated and repeated**](/orchestrator/) data collection,
## Working with Data Destination Connectors
Each data destination connector can have multiple configurations. Each configuration usually represents a single destination (database account, BI project, etc.).
Even though destination connectors are generally designed for [**automated and repeated**](/orchestrator/) data collection,
they can be triggered manually at any time.

We provide tutorials on [writing into GoodData](/tutorial/write/gooddata/) and [writing into Tableau](/tutorial/write/).
Expand Down
62 changes: 25 additions & 37 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,41 @@
---
title: Keboola Connection User Documentation
title: Keboola User Documentation
permalink: /
---

Welcome to the Keboola Connection Manual pages.
If you are working with the Keboola Connection UI as an end-user, you are at the right place.
Welcome to the Keboola documentation—a comprehensive resource offering step-by-step guidance and reference information to help users
seamlessly navigate the platform. Whether you're a newcomer or an experienced user, this documentation is your go-to companion for mastering
the ins and outs of Keboola.

* TOC
{:toc}

## What is Keboola Connection?

Keboola Connection is a powerful data preparation platform composed of many interconnected components,
extracting data from various sources,
manipulating and enriching the data, and writing the results to desired Business Intelligence tools.
It is a safe, open and extendable cloud based environment for working with your data.

## Where to Start
If you are new to Keboola and **would like a quick orientation** to the Keboola ecosystem, explore our comprehensive [overview](/overview/).

If you are new to Keboola Connection and want a **brief orientation** to the Keboola ecosystem,
please check out our [overview](/overview/), or watch a short [introductory video](https://www.youtube.com/watch?v=yaA7_N5Ymmc&feature=youtu.be).
For some hands-on experience, see our [tutorial](/tutorial/).

If you are already familiar with how Keboola Connection works, go directly to [connection.keboola.com](https://connection.keboola.com)
and log in. If your project is not in the default US region, use the region selector to choose the appropriate region.

We are available to provide [support](/management/support/) whenever needed. In case you don't have access
to a Keboola Connection project, you can write an email to [support@keboola.com](mailto:support@keboola.com).
Please use the [support form](/management/support/) inside your project as that provides
us with valuable context.

## More to Read

- [www.keboola.com](https://www.keboola.com/) --- our main web page
- [blog.keboola.com](https://blog.keboola.com/) --- something to read for data analysts
- [500.keboola.com](https://500.keboola.com/) --- something to read for tech geeks
- [developers.keboola.com](https://developers.keboola.com) --- documentation for extending or integrating Keboola Connection
Ready to take the next step? Grab your free trial and set up your account [here](https://connection.north-europe.azure.keboola.com/wizard),
or connect with our team directly through [this link](https://www.keboola.com/contact).

## Keboola Connection Status Updates
For some hands-on experience, dive into our Getting Started [tutorial](/tutorial/).

There are two equivalent places where you can get Keboola Connection Status updates (service status and changelog):
Rest assured, we're here to support you whenever needed. Reach out via email at [support@keboola.com](support@keboola.com) or use the [support form](https://help.keboola.com/management/support/) directly within your project.

- [status.keboola.com](https://status.keboola.com/) --- we recommend subscribing to the feed
- [Twitter](https://twitter.com/keboola_support)
## Manage Keboola
- [User management](/management/#user-management)
- [Account administration](/management/account/)
- [Data governance](/management/account/)

## Your Tips and Suggestions
Use the *Feature Wishlist* in the *Settings* menu or [ideas.keboola.com](https://ideas.keboola.com/)
to send us your suggestions for new features or improvements.
## Reference
- [API reference](https://developers.keboola.com/overview/api/)
- [Release notes](https://changelog.keboola.com/)

{: .image-popup}
![Screenshot - Wishlist](/wishlist.png)
## Resources
- [status.keboola.com](http://status.keboola.com/) – get Keboola status updates (we recommend subscribing to the feed)
- [www.keboola.com](https://www.keboola.com/) – our main web page
- [blog.keboola.com](https://blog.keboola.com/) – something to read for data analysts
- [500.keboola.com](https://500.keboola.com/) – something to read for tech geeks
- [developers.keboola.com](https://developers.keboola.com) – documentation for extending or integrating Keboola Connection

## We Highly Appreciate Your Input!
Feel free to utilize the support form within your Keboola project to share feedback, request new features or components,
or engage in a conversation with us. Your insights are valuable, and we're here to listen and collaborate.
2 changes: 2 additions & 0 deletions orchestrator/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Orchestrator
permalink: /orchestrator/
---

***Note:** This page will be updated soon. *

Bringing systems for data loading, manipulation and writing together is what makes
[Keboola Connection](/overview/) so powerful and easy to use. With [extractors](/components/extractors/), you can fetch
data from data sources into [Storage](/storage/). With [transformations](/transformations/) and
Expand Down
Loading

0 comments on commit 6bb762d

Please sign in to comment.