Update low-code documentation #15748

girarda · 2022-08-18T01:07:45Z

What

A few more edits/corrections to the low-code documentation.

How

Fix a few typos
Add or remove end of line dots for consistency
Fix a few links

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub and connector version bumped by running the /publish command described here

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

girarda · 2022-08-18T14:36:15Z

docs/connector-development/config-based/yaml-structure.md

@@ -135,7 +135,7 @@ In this example, outer.inner.k2 will evaluate to "MyKey is MyValue"
 ## References

 Strings can contain references to previously defined values.
-The parser will dereference these values to produce a complete ConnectionDefinition
+The parser will dereference these values to produce a complete object definition.


ConnectionDefinition is not a term we define anywhere

girarda · 2022-08-18T14:36:27Z

docs/connector-development/config-based/index.md

@@ -3,7 +3,7 @@
 ## From scratch

 - [Overview](overview.md)
- [Yaml structure](overview.md)
+- [Yaml structure](yaml-structure.md)


girarda · 2022-08-18T14:36:40Z

docs/connector-development/config-based/overview.md

@@ -51,12 +51,12 @@ A stream generally corresponds to a resource within the API. They are analogous
 A stream is defined by:

 1. A name
-2. Primary key (Optional): Used to uniquely identify records, enabling deduplication. Can be a string for single primary keys, a list of strings for composite primary keys, or a list of list of strings for composite primary keys consisting of nested fields.
+2. Primary key (Optional): Used to uniquely identify records, enabling deduplication. Can be a string for single primary keys, a list of strings for composite primary keys, or a list of list of strings for composite primary keys consisting of nested fields


remove dots for consistency

girarda · 2022-08-18T14:37:34Z

docs/connector-development/config-based/overview.md

-More details on the record selector can be found in the [record selector section](record-selector.md)
-More details on the stream slicers can be found in the [stream slicers section](stream-slicers.md)
-More details on the paginator can be found in the [pagination section](pagination.md)
+More details on the record selector can be found in the [record selector section](record-selector.md).


add newlines because these all show up as a single line in the docs

girarda · 2022-08-18T14:37:49Z

docs/connector-development/config-based/stream-slicers.md

@@ -164,7 +163,7 @@ retriever:
        stream_slice_field: "repository"
 ```

-[^1] This is a slight oversimplification. See update cursor section for more details on how the cursor is updated
+[^1] This is a slight oversimplification. See [update cursor section](#cursor-update) for more details on how the cursor is updated.


add a link to the section

girarda · 2022-08-18T14:37:59Z

docs/connector-development/config-based/tutorial/0-getting-started.md

@@ -8,7 +8,7 @@ Throughout this tutorial, we'll walk you through the creation an Airbyte source

 We'll build a connector reading data from the Exchange Rates API, but the steps will apply to other HTTP APIs you might be interested in integrating with.

-The API documentations can be found [here](https://exchangeratesapi.io/documentation/).
+The API documentations can be found [here](https://apilayer.com/marketplace/exchangerates_data-api).


point to their updated api docs

girarda · 2022-08-18T14:38:14Z

docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

@@ -141,7 +141,7 @@ definitions:
        base: "{{ config['base'] }}"
 ```

-The full connection definition should now look like
+The full connector definition should now look like


this is a connector, not a connection

* newlines * remove dots for consistency * a few more edits * more edits

girarda added 2 commits August 17, 2022 18:03

newlines

62dc4b3

remove dots for consistency

fb56e2a

github-actions bot added the area/documentation Improvements or additions to documentation label Aug 18, 2022

girarda added 2 commits August 18, 2022 07:05

a few more edits

d0f3249

more edits

1b5f506

girarda commented Aug 18, 2022

View reviewed changes

Merge branch 'master' into alex/docs

f9526c4

girarda requested review from brianjlai and sherifnada August 18, 2022 14:43

girarda changed the title ~~Alex/docs~~ Update low-code documentation Aug 18, 2022

girarda marked this pull request as ready for review August 18, 2022 14:43

sherifnada approved these changes Aug 18, 2022

View reviewed changes

girarda merged commit 2569071 into master Aug 18, 2022

girarda deleted the alex/docs branch August 18, 2022 15:13

octavia-squidington-iii mentioned this pull request Aug 19, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1-alpha #15775

Closed

evantahler mentioned this pull request Aug 22, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1 #15857

Merged

rodireich pushed a commit that referenced this pull request Aug 25, 2022

Update low-code documentation (#15748)

a9f5f21

* newlines * remove dots for consistency * a few more edits * more edits

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update low-code documentation #15748

Update low-code documentation #15748

girarda commented Aug 18, 2022 •

edited

Loading

girarda Aug 18, 2022

girarda Aug 18, 2022

girarda Aug 18, 2022

girarda Aug 18, 2022

girarda Aug 18, 2022

girarda Aug 18, 2022

girarda Aug 18, 2022

Update low-code documentation #15748

Update low-code documentation #15748

Conversation

girarda commented Aug 18, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda Aug 18, 2022

Choose a reason for hiding this comment

girarda commented Aug 18, 2022 •

edited

Loading