Skip to content

Make config-based docs accessible through direct link #15662

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 5 commits into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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/config-based/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning:

The goal of this document is to give enough technical specifics to understand how config-based connectors work.
When you're ready to start building a connector, you can start with [the tutorial](../../../config-based/tutorial/0-getting-started.md) or dive into the [reference documentation](https://airbyte-cdk.readthedocs.io/en/latest/api/airbyte_cdk.sources.declarative.html)
When you're ready to start building a connector, you can start with [the tutorial](./tutorial/0-getting-started.md) or dive into the [reference documentation](https://airbyte-cdk.readthedocs.io/en/latest/api/airbyte_cdk.sources.declarative.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fix link


## Overview

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The connector will now always read data for the start date, which is not exactly
Instead, we would like to iterate over all the dates between the start_date and today and read data for each day.

We can do this by adding a `DatetimeStreamSlicer` to the connector definition, and update the `path` to point to the stream_slice's `start_date`:
More details on the stream slicers can be found [here](./link-to-stream-slicers.md) <FIXME: need to fix links>
More details on the stream slicers can be found [here](../stream-slicers.md) <FIXME: need to fix links>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fix link


Let's first define a stream slicer at the top level of the connector definition:

Expand Down Expand Up @@ -298,4 +298,4 @@ Next, we'll run the [Source Acceptance Tests suite to ensure the connector invar

- [Incremental reads](../../cdk-python/incremental-stream.md)
- [Stream slicers](../stream-slicers.md)
- [Stream slices](../cdk-python/stream-slices.md)
- [Stream slices](../../cdk-python/stream-slices.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fix link

Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ $ python -m pytest integration_tests -p integration_tests.acceptance

Next, we'll add the connector to the [Airbyte platform](https://docs.airbyte.com/connector-development/tutorials/cdk-tutorial-python-http/use-connector-in-airbyte).

See your [Contributiong guide]() on how to get started releasing your connector.
See your [Contributiong guide](../../../contributing-to-airbyte/README.md) on how to get started releasing your connector.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fix link


## Read more:

Expand Down
2 changes: 1 addition & 1 deletion docs/connector-development/config-based/yaml-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ In this example, outer.inner.k2 will evaluate to "MyKey is MyValue"
Strings can contain references to previously defined values.
The parser will dereference these values to produce a complete ConnectionDefinition

References can be defined using a *ref(<arg>) string.
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 think docusaurus was interpreting the <> as an html directive. the build step stopped complaining after changing to {arg}

References can be defined using a "*ref({arg})" string.

```yaml
key: 1234
Expand Down
1 change: 0 additions & 1 deletion docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ const config = {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/airbytehq/airbyte/blob/master/docs',
path: '../docs',
exclude: ['**/connector-development/config-based/**']
Copy link
Contributor Author

Choose a reason for hiding this comment

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

include /connector-development/config-based/ to the build, but not to the sidebar

},
blog: false,
theme: {
Expand Down