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

docs: remove redundant content from connector's READMEs (discussing, do not merge) #52698

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft
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
13 changes: 13 additions & 0 deletions airbyte-integrations/connectors/destination-mssql/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Microsoft SQL Server (MSSQL) Destination

This is the repository for the Microsoft SQL Server destination connector in Java.

For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/destinations/mssql).

## Development and Testing

For information about developing and testing this connector, see [Building a Java Destination](https://docs.airbyte.com/connector-development/tutorials/building-a-java-destination).

## Publishing

For instructions on publishing changes to this connector, see [Publishing a Connector](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#publishing-a-new-version-of-a-connector).
28 changes: 6 additions & 22 deletions airbyte-integrations/connectors/source-freshchat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,15 @@ This directory contains the manifest-only connector for `source-freshchat`.

Freshchat is a cloud based messaging solution that allows you to effectively interact with your business users. It provides an efficient messaging service for lead generation, customer engagement, and customer support and thereby, makes your business competent.

## Usage
There are multiple ways to use this connector:
- You can use this connector as any other connector in Airbyte Marketplace.
- You can load this connector in `pyairbyte` using `get_source`!
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
## Usage and Configuration

Please refer to the manifest-only connector documentation for more details.
For information about how to configure and use this connector within Airbyte, see [the connector's documentation](https://docs.airbyte.com/integrations/sources/freshchat).

## Local Development
We recommend you use the Connector Builder to edit this connector.
## Development and Testing

But, if you want to develop this connector locally, you can use the following steps.
For information about developing, building, and testing this connector, see [Developing a Manifest-Only Connector](https://docs.airbyte.com/connector-development/connector-builder-ui/overview).

### Environment Setup
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).
## Publishing

### Build
This will create a dev image (`source-freshchat:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-freshchat build
```

### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-freshchat test
```
For instructions on publishing changes to this connector, see [Publishing a Connector](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#publishing-a-new-version-of-a-connector).

59 changes: 4 additions & 55 deletions airbyte-integrations/connectors/source-linkedin-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,61 +5,10 @@ This _manifest-only_ connector is not a Python package on its own, as it runs in

For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/linkedin-pages).

## Local development
## Development and Testing

We recommend using the Connector Builder to edit this connector.
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
For information about developing, building, and testing this connector, see [Developing a Manifest-Only Connector](https://docs.airbyte.com/connector-development/connector-builder-ui/overview).

If you prefer to develop locally, you can follow the instructions below.
## Publishing

### Building the docker image

You can build any manifest-only connector with `airbyte-ci`:

1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:

```bash
airbyte-ci connectors --name=source-linkedin-pages build
```

An image will be available on your host with the tag `airbyte/source-linkedin-pages:dev`.

### Creating credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/linkedin-pages)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.

### Running as a docker container

Then run any of the standard source connector commands:

```bash
docker run --rm airbyte/source-linkedin-pages:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linkedin-pages:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linkedin-pages:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-linkedin-pages:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

### Running the CI test suite

You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):

```bash
airbyte-ci connectors --name=source-linkedin-pages test
```

## Publishing a new version of the connector

If you want to contribute changes to `source-linkedin-pages`, here's how you can do that:
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-linkedin-pages test`
3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/linkedin-pages.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
For instructions on publishing changes to this connector, see [Publishing a Connector](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#publishing-a-new-version-of-a-connector).
59 changes: 4 additions & 55 deletions airbyte-integrations/connectors/source-the-guardian-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,61 +5,10 @@ This _manifest-only_ connector is not a Python package on its own, as it runs in

For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/the-guardian-api).

## Local development
## Development and Testing

We recommend using the Connector Builder to edit this connector.
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
For information about developing, building, and testing this connector, see [Developing a Manifest-Only Connector](https://docs.airbyte.com/connector-development/connector-builder-ui/overview).

If you prefer to develop locally, you can follow the instructions below.
## Publishing

### Building the docker image

You can build any manifest-only connector with `airbyte-ci`:

1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:

```bash
airbyte-ci connectors --name=source-the-guardian-api build
```

An image will be available on your host with the tag `airbyte/source-the-guardian-api:dev`.

### Creating credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/the-guardian-api)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.

### Running as a docker container

Then run any of the standard source connector commands:

```bash
docker run --rm airbyte/source-the-guardian-api:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-the-guardian-api:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-the-guardian-api:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-the-guardian-api:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

### Running the CI test suite

You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):

```bash
airbyte-ci connectors --name=source-the-guardian-api test
```

## Publishing a new version of the connector

If you want to contribute changes to `source-the-guardian-api`, here's how you can do that:
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-the-guardian-api test`
3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/the-guardian-api.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
For instructions on publishing changes to this connector, see [Publishing a Connector](https://docs.airbyte.com/contributing-to-airbyte/change-cdk-connector/#publishing-a-new-version-of-a-connector).
Loading