Skip to content

docs: update and remove some bad content #36197

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

Merged
merged 1 commit into from
Mar 15, 2024
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
2 changes: 1 addition & 1 deletion docs/connector-development/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Connector Development

There are two types of connectors in Airbyte: Sources and Destinations. Connectors can be built in any programming
language,as long as they're built into docker images that impoement the
language, as long as they're built into docker images that implement the
[Airbyte specification](../understanding-airbyte/airbyte-protocol.md).

Most database sources and destinations are written in Java, and most API sources and destinations are written in Python
Expand Down
4 changes: 2 additions & 2 deletions docs/connector-development/connector-metadata-file.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Connector Metadata.yaml File

The `metadata.yaml` file is a new addition to Airbyte's connector folders. This file is created with the goal of simplifying and enhancing how we manage information related to each connector. It is designed to replace the previous `source_definitions.yaml` and `destinations_definitions.yaml` files.

The `metadata.yaml` file contains crucial information about the connector, including its type, definition ID, Docker image tag, Docker repository, and much more. It plays a key role in the way Airbyte handles connector data and improves the overall organization and accessibility of this data.

N.B. the `metadata.yaml` file replaces the previous `source_definitions.yaml` and `destinations_definitions.yaml` files.

## Structure

Below is an example of a `metadata.yaml` file for the Postgres source:
Expand Down
4 changes: 2 additions & 2 deletions docs/connector-development/migration-to-base-image.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Migration guide: How to make a connector use our base image
# Migration Guide: How to make a python connector use our base image

We currently enforce our certified connectors to use our [base image](https://hub.docker.com/r/airbyte/python-connector-base).
We currently enforce our certified python connectors to use our [base image](https://hub.docker.com/r/airbyte/python-connector-base).
This guide will help connector developers to migrate their connector to use our base image.

N.B: This guide currently only applies to python connectors.
Expand Down

This file was deleted.

119 changes: 0 additions & 119 deletions docs/connector-development/tutorials/profile-java-connector-memory.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/contributing-to-airbyte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The usual workflow of code contribution is:
5. Push your local branch to your fork.
6. Submit a Pull Request so that we can review your changes.
7. [Link an existing Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) that does not include the `needs triage` label to your Pull Request. A pull request without a linked issue will be closed, otherwise.
8. Write a PR title and description that follows the [Pull Request Handbook](./resources/pull-requests-handbook.md) and [Pull Request Template](https://github.com/airbytehq/airbyte/blob/master/.github/pull_request_template.md).
8. Write a PR title and description that follows the [Pull Request Handbook](./resources/pull-requests-handbook.md).
9. An Airbyte maintainer will trigger the CI tests for you and review the code.
10. Review and respond to feedback and questions by Airbyte maintainers.
11. Merge the contribution.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-to-airbyte/change-cdk-connector.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Changes to CDK or Low-Code Connector
# Changes to Python CDK or Low-Code Connector

## Contribution Process

Expand Down
53 changes: 0 additions & 53 deletions docs/contributing-to-airbyte/resources/code-style.md

This file was deleted.

30 changes: 1 addition & 29 deletions docs/contributing-to-airbyte/resources/developing-locally.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This page is confusing, but I think partially correct and we should keep something like this around.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll see what I can to. I think I might have gotten confused.

Original file line number Diff line number Diff line change
Expand Up @@ -156,35 +156,7 @@ If you are working in the platform run `SUB_BUILD=PLATFORM ./gradlew format` fro

### Connector

To format an individual connector in python, run the following command in your local `airbyte` repository:

```
./gradlew :airbyte-integrations:connectors:<connector_name>:airbytePythonFormat
```

For instance:

```
./gradlew :airbyte-integrations:connectors:source-s3:airbytePythonFormat
```

To format connectors in java, run `./gradlew format`

### Connector Infrastructure

Finally, if you are working in any module in `:airbyte-integrations:bases` or `:airbyte-cdk:python`, run the following command in your local `airbyte` repository:

```bash
SUB_BUILD=CONNECTORS_BASE ./gradlew format
```

Note: If you are contributing a Python file without imports or function definitions, place the following comment at the top of your file:

```python
"""
[FILENAME] includes [INSERT DESCRIPTION OF CONTENTS HERE]
"""
```
To format your local `airbyte` repository, run `airbyte-ci format fix all`.

### Develop on `airbyte-webapp`

Expand Down
Loading
Loading