Skip to content
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

Add docs sidebar #11817

Merged
merged 4 commits into from
Apr 7, 2022
Merged
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
32 changes: 32 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: compile-docusaurus-static-assets

on:
push:
branches: [master]


# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
verify-docusaurus-static-files:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Check out repo
# `uses` taps GH ORG/REPO@version.
# "actions" is a default org for some common GH actions
uses: actions/checkout@v3
with:
fetch-depth: 0
# Node is required for yarn
- name: Set up Yarn
uses: actions/setup-node@v2
with:
node-version: '16.13.0'
cache: 'yarn'
cache-dependency-path: docusaurus
# Install and build Docusaurus website
- name: Check for docusaurus changes
run: ./tools/bin/check_docusaurus_build_changes
2 changes: 0 additions & 2 deletions docs/connector-development/tutorials/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/deploying-airbyte/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/integrations/destinations/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/operator-guides/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/quickstart/README.md

This file was deleted.

71 changes: 63 additions & 8 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,70 @@
# docs (by Docusaurus)
# Introduction
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a copy of /README.md Docusaurus doesn't like doing above it's root directory. I tried a symlink and the link appears to fail docusaurus's build steps so I just copied to move past the problem as a blocker

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean we have a duplicate? If we can't figure this out, we could change the workflow to copy the top level readme in this directory as part of the workflow.

@Amruta-Ranade do you have thoughts on the repo readme vs the docs.airbyte.io readme? We've kept it the same for continuity. I want to continue doing so and was wondering if you have other plans.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do have plans to edit the landing page text. The repo readme is perfect for the OSS audience but I'd like the docs readme to be more user-centric. Keeping them separate makes sense to me.


This directory contains our docs that are hosted at docs.airbyte.io.
[![GitHub stars](https://img.shields.io/github/stars/airbytehq/airbyte?style=social&label=Star&maxAge=2592000)](https://github.com/airbytehq/airbyte/stargazers/) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/airbytehq/airbyte/Airbyte%20CI)](https://github.com/airbytehq/airbyte/actions/workflows/gradle.yml) [![License](https://img.shields.io/static/v1?label=license&message=MIT&color=brightgreen)](https://github.com/airbytehq/airbyte/tree/a9b1c6c0420550ad5069aca66c295223e0d05e27/LICENSE/README.md) [![License](https://img.shields.io/static/v1?label=license&message=ELv2&color=brightgreen)](https://github.com/airbytehq/airbyte/tree/a9b1c6c0420550ad5069aca66c295223e0d05e27/LICENSE/README.md)

We leverage docusaurus for documentation. You can run the server locally by navigating to
**Data integration made simple, secure and extensible.**
The new open-source standard to sync data from applications, APIs & databases to warehouses, lakes & other destinations.

`airbyte/docusaurus`
Airbyte is on a mission to make data integration pipelines a commodity.

and running:
* **Maintenance-free connectors you can use in minutes**. Just authenticate your sources and warehouse, and get connectors that adapt to schema and API changes for you.
* **Building new connectors made trivial.** We make it very easy to add new connectors that you need, using the language of your choice, by offering scheduling and orchestration.
* Designed to **cover the long tail of connectors and needs**. Benefit from the community's battle-tested connectors and adapt them to your specific needs.
* **Your data stays in your cloud**. Have full control over your data, and the costs of your data transfers.
* **No more security compliance process** to go through as Airbyte is self-hosted.
* **No more pricing indexed on volume**, as cloud-based solutions offer.

`yarn build && yarn serve`
Here's a list of our [connectors with their health status](docs/integrations/).

This build will also happen in the cloud, however if a diff is detected the cloud test will fail
## Quick start

```bash
git clone https://github.com/airbytehq/airbyte.git
cd airbyte
docker-compose up
```

Now visit [http://localhost:8000](http://localhost:8000)

Here is a [step-by-step guide](https://github.com/airbytehq/airbyte/tree/e378d40236b6a34e1c1cb481c8952735ec687d88/docs/quickstart/getting-started.md) showing you how to load data from an API into a file, all on your computer.

## Features

* **Built for extensibility**: Adapt an existing connector to your needs or build a new one with ease.
* **Optional normalized schemas**: Entirely customizable, start with raw data or from some suggestion of normalized data.
* **Full-grade scheduler**: Automate your replications with the frequency you need.
* **Real-time monitoring**: We log all errors in full detail to help you understand.
* **Incremental updates**: Automated replications are based on incremental updates to reduce your data transfer costs.
* **Manual full refresh**: Sometimes, you need to re-sync all your data to start again.
* **Debugging autonomy**: Modify and debug pipelines as you see fit, without waiting.

[See more on our website.](https://airbyte.io/features/)

## Contributing

We love contributions to Airbyte, big or small.

See our [Contributing guide](docs/contributing-to-airbyte/) on how to get started. Not sure where to start? We’ve listed some [good first issues](https://github.com/airbytehq/airbyte/labels/good%20first%20issue) to start with. If you have any questions, please open a draft PR or visit our [slack channel](https://github.com/airbytehq/airbyte/tree/a9b1c6c0420550ad5069aca66c295223e0d05e27/slack.airbyte.io) where the core team can help answer your questions.

**Note that you are able to create connectors using the language you want, as Airbyte connections run as Docker containers.**

**Also, we will never ask you to maintain your connector. The goal is that the Airbyte team and the community helps maintain it, let's call it crowdsourced maintenance!**

## Community support

For general help using Airbyte, please refer to the official Airbyte documentation. For additional help, you can use one of these channels to ask a question:

* [Slack](https://slack.airbyte.io) \(For live discussion with the Community and Airbyte team\)
* [Forum](https://discuss.airbyte.io/) \(For deeper converstaions about features, connectors, or problems\)
* [GitHub](https://github.com/airbytehq/airbyte) \(Bug reports, Contributions\)
* [Twitter](https://twitter.com/airbytehq) \(Get the news fast\)
* [Weekly office hours](https://airbyte.io/weekly-office-hours/) \(Live informal 30-minute video call sessions with the Airbyte team\)

## Roadmap

Check out our [roadmap](docs/project-overview/roadmap.md) to get informed on what we are currently working on, and what we have in mind for the next weeks, months and years.

## License

See the [LICENSE](docs/project-overview/licenses/) file for licensing information, and our [FAQ](docs/project-overview/licenses/license-faq.md) for any questions you may have on that topic.

You **must** run yarn build successfully before committing your changes
File renamed without changes.
Loading