From 6c730d5cd4509e62c93a53f18b7445c9810aad53 Mon Sep 17 00:00:00 2001 From: Nataly Merezhuk <65251165+natalyjazzviolin@users.noreply.github.com> Date: Fri, 30 Sep 2022 11:54:50 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Removes=20$=20from=20terminal=20?= =?UTF-8?q?commands=20to=20allow=20direct=20copying.=20(#17467)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Removes $ from terminal commands to allow direct copying. * Fixes build by adding missing link. --- .../config-based/tutorial/1-create-source.md | 8 ++++---- .../config-based/tutorial/2-install-dependencies.md | 10 +++++----- .../tutorial/3-connecting-to-the-API-source.md | 4 ++-- .../config-based/tutorial/4-reading-data.md | 10 +++++----- .../config-based/tutorial/5-incremental-reads.md | 6 +++--- .../config-based/tutorial/6-testing.md | 4 ++-- docs/integrations/sources/dv360.md | 2 +- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/connector-development/config-based/tutorial/1-create-source.md b/docs/connector-development/config-based/tutorial/1-create-source.md index c2eebb5ace802..05c1d67e9a7fd 100644 --- a/docs/connector-development/config-based/tutorial/1-create-source.md +++ b/docs/connector-development/config-based/tutorial/1-create-source.md @@ -3,15 +3,15 @@ Let's start by cloning the Airbyte repository: ```bash -$ git clone git@github.com:airbytehq/airbyte.git -$ cd airbyte +git clone git@github.com:airbytehq/airbyte.git +cd airbyte ``` Airbyte provides a code generator which bootstraps the scaffolding for our connector. ```bash -$ cd airbyte-integrations/connector-templates/generator -$ ./generate.sh +cd airbyte-integrations/connector-templates/generator +./generate.sh ``` This will bring up an interactive helper application. Use the arrow keys to pick a template from the list. Select the `Configuration Based Source` template and then input the name of your connector. The application will create a new directory in `airbyte/airbyte-integrations/connectors/` with the name of your new connector. diff --git a/docs/connector-development/config-based/tutorial/2-install-dependencies.md b/docs/connector-development/config-based/tutorial/2-install-dependencies.md index b165557c62d28..06bc75dc38d66 100644 --- a/docs/connector-development/config-based/tutorial/2-install-dependencies.md +++ b/docs/connector-development/config-based/tutorial/2-install-dependencies.md @@ -8,10 +8,10 @@ If this is the case on your machine, substitute the `python` commands with `pyth The subsequent `python` invocations will use the virtual environment created for the connector. ```bash -$ cd ../../connectors/source-exchange-rates-tutorial -$ python -m venv .venv -$ source .venv/bin/activate -$ pip install -r requirements.txt +cd ../../connectors/source-exchange-rates-tutorial +python -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt ``` These steps create an initial python environment, and install the dependencies required to run an API Source connector. @@ -19,7 +19,7 @@ These steps create an initial python environment, and install the dependencies r Let's verify everything works as expected by running the Airbyte `spec` operation: ```bash -$ python main.py spec +python main.py spec ``` You should see an output similar to the one below: diff --git a/docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md b/docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md index 3527630a290da..48e9c199c50f8 100644 --- a/docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md +++ b/docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md @@ -53,7 +53,7 @@ connectionSpecification: Because of the sensitive nature of the access key, we recommend storing this config in the `secrets` directory because it is ignored by git. ```bash -$ echo '{"access_key": "", "base": "USD"}' > secrets/config.json +echo '{"access_key": "", "base": "USD"}' > secrets/config.json ``` ## Updating the connector definition @@ -197,7 +197,7 @@ check: We can now run the `check` operation, which verifies the connector can connect to the API source. ```bash -$ python main.py check --config secrets/config.json +python main.py check --config secrets/config.json ``` which should now succeed with logs similar to: diff --git a/docs/connector-development/config-based/tutorial/4-reading-data.md b/docs/connector-development/config-based/tutorial/4-reading-data.md index a59c7d997b1f5..074ca1b64c76c 100644 --- a/docs/connector-development/config-based/tutorial/4-reading-data.md +++ b/docs/connector-development/config-based/tutorial/4-reading-data.md @@ -29,20 +29,20 @@ Let's define the stream schema in `source-exchange-rates-tutorial/source_exchang You can download the JSON file describing the output schema with all currencies [here](https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-cdk/python/docs/tutorials/http_api_source_assets/exchange_rates.json) for convenience and place it in `schemas/`. ```bash -$ curl https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-cdk/python/docs/tutorials/http_api_source_assets/exchange_rates.json > source_exchange_rates_tutorial/schemas/rates.json +curl https://raw.githubusercontent.com/airbytehq/airbyte/master/airbyte-cdk/python/docs/tutorials/http_api_source_assets/exchange_rates.json > source_exchange_rates_tutorial/schemas/rates.json ``` We can also delete the boilerplate schema files ```bash -$ rm source_exchange_rates_tutorial/schemas/customers.json -$ rm source_exchange_rates_tutorial/schemas/employees.json +rm source_exchange_rates_tutorial/schemas/customers.json +rm source_exchange_rates_tutorial/schemas/employees.json ``` Reading from the source can be done by running the `read` operation ```bash -$ python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json ``` The logs should show that 1 record was read from the stream. @@ -55,7 +55,7 @@ The logs should show that 1 record was read from the stream. The `--debug` flag can be set to print out debug information, including the outgoing request and its associated response ```bash -$ python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json --debug +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json --debug ``` ## Next steps diff --git a/docs/connector-development/config-based/tutorial/5-incremental-reads.md b/docs/connector-development/config-based/tutorial/5-incremental-reads.md index 4fff6c9b22a9b..84a529ba87e12 100644 --- a/docs/connector-development/config-based/tutorial/5-incremental-reads.md +++ b/docs/connector-development/config-based/tutorial/5-incremental-reads.md @@ -79,7 +79,7 @@ streams: You can test these changes by executing the `read` operation: ```bash -$ python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json ``` By reading the output record, you should see that we read historical data instead of the latest exchange rate. @@ -226,7 +226,7 @@ check: Running the `read` operation will now read all data for all days between start_date and now: ```bash -$ python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json ``` The operation should now output more than one record: @@ -281,7 +281,7 @@ We can simulate incremental syncs by creating a state file containing the last s Running the `read` operation will now only read data for dates later than the given state: ```bash -$ python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json --state integration_tests/sample_state.json +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json --state integration_tests/sample_state.json ``` There shouldn't be any data read if the state is today's date: diff --git a/docs/connector-development/config-based/tutorial/6-testing.md b/docs/connector-development/config-based/tutorial/6-testing.md index e83dbdf5b7640..45bb3199c84c6 100644 --- a/docs/connector-development/config-based/tutorial/6-testing.md +++ b/docs/connector-development/config-based/tutorial/6-testing.md @@ -31,8 +31,8 @@ and `integration_tests/abnormal_state.json` with You can run the acceptance tests with the following commands: ```bash -$ docker build . -t airbyte/source-exchange-rates-tutorial:dev -$ python -m pytest integration_tests -p integration_tests.acceptance +docker build . -t airbyte/source-exchange-rates-tutorial:dev +python -m pytest integration_tests -p integration_tests.acceptance ``` ## Next steps: diff --git a/docs/integrations/sources/dv360.md b/docs/integrations/sources/dv360.md index eb4efb4eb8220..c1f3b6e76d7cd 100644 --- a/docs/integrations/sources/dv360.md +++ b/docs/integrations/sources/dv360.md @@ -67,4 +67,4 @@ This source is constrained by the limits set by the DBM API. You can read more a | Version | Date | Pull Request | Subject | | :--- | :--- | :--- | :--- | -| 0.1.1 | 2022--| []() | Release Native Display & Video 360 Connector | \ No newline at end of file +| 0.1.1 | 2022--| [11828](https://github.com/airbytehq/airbyte/pull/11828) | Release Native Display & Video 360 Connector | \ No newline at end of file