Skip to content

Commit f90b5d1

Browse files
author
Marius Posta
authored
docs: update and remove some bad content (#36197)
1 parent cec938f commit f90b5d1

File tree

14 files changed

+11
-695
lines changed

14 files changed

+11
-695
lines changed

docs/connector-development/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Connector Development
22

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

77
Most database sources and destinations are written in Java, and most API sources and destinations are written in Python

docs/connector-development/connector-metadata-file.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Connector Metadata.yaml File
22

3-
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.
4-
53
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.
64

5+
N.B. the `metadata.yaml` file replaces the previous `source_definitions.yaml` and `destinations_definitions.yaml` files.
6+
77
## Structure
88

99
Below is an example of a `metadata.yaml` file for the Postgres source:

docs/connector-development/migration-to-base-image.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Migration guide: How to make a connector use our base image
1+
# Migration Guide: How to make a python connector use our base image
22

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

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

docs/connector-development/testing-connectors/standard-source-tests.md

-4
This file was deleted.

docs/connector-development/tutorials/profile-java-connector-memory.md

-119
This file was deleted.

docs/contributing-to-airbyte/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The usual workflow of code contribution is:
4444
5. Push your local branch to your fork.
4545
6. Submit a Pull Request so that we can review your changes.
4646
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.
47-
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).
47+
8. Write a PR title and description that follows the [Pull Request Handbook](./resources/pull-requests-handbook.md).
4848
9. An Airbyte maintainer will trigger the CI tests for you and review the code.
4949
10. Review and respond to feedback and questions by Airbyte maintainers.
5050
11. Merge the contribution.

docs/contributing-to-airbyte/change-cdk-connector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Changes to CDK or Low-Code Connector
1+
# Changes to Python CDK or Low-Code Connector
22

33
## Contribution Process
44

docs/contributing-to-airbyte/resources/code-style.md

-53
This file was deleted.

docs/contributing-to-airbyte/resources/developing-locally.md

+1-29
Original file line numberDiff line numberDiff line change
@@ -156,35 +156,7 @@ If you are working in the platform run `SUB_BUILD=PLATFORM ./gradlew format` fro
156156

157157
### Connector
158158

159-
To format an individual connector in python, run the following command in your local `airbyte` repository:
160-
161-
```
162-
./gradlew :airbyte-integrations:connectors:<connector_name>:airbytePythonFormat
163-
```
164-
165-
For instance:
166-
167-
```
168-
./gradlew :airbyte-integrations:connectors:source-s3:airbytePythonFormat
169-
```
170-
171-
To format connectors in java, run `./gradlew format`
172-
173-
### Connector Infrastructure
174-
175-
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:
176-
177-
```bash
178-
SUB_BUILD=CONNECTORS_BASE ./gradlew format
179-
```
180-
181-
Note: If you are contributing a Python file without imports or function definitions, place the following comment at the top of your file:
182-
183-
```python
184-
"""
185-
[FILENAME] includes [INSERT DESCRIPTION OF CONTENTS HERE]
186-
"""
187-
```
159+
To format your local `airbyte` repository, run `airbyte-ci format fix all`.
188160

189161
### Develop on `airbyte-webapp`
190162

0 commit comments

Comments
 (0)