Skip to content

Commit 2fd43d4

Browse files
authored
Make config-based docs accessible through direct link (#15662)
* fix broken links * include config-based * throw on broken links * fix link * reset
1 parent ef7f1a0 commit 2fd43d4

File tree

6 files changed

+14
-13
lines changed

6 files changed

+14
-13
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning:
44

55
The goal of this document is to give enough technical specifics to understand how config-based connectors work.
6-
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)
6+
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)
77

88
## Overview
99

docs/connector-development/config-based/tutorial/5-incremental-reads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The connector will now always read data for the start date, which is not exactly
9090
Instead, we would like to iterate over all the dates between the start_date and today and read data for each day.
9191

9292
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`:
93-
More details on the stream slicers can be found [here](./link-to-stream-slicers.md) <FIXME: need to fix links>
93+
More details on the stream slicers can be found [here](../stream-slicers.md) <FIXME: need to fix links>
9494

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

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

299299
- [Incremental reads](../../cdk-python/incremental-stream.md)
300300
- [Stream slicers](../stream-slicers.md)
301-
- [Stream slices](../cdk-python/stream-slices.md)
301+
- [Stream slices](../../cdk-python/stream-slices.md)

docs/connector-development/config-based/tutorial/6-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $ python -m pytest integration_tests -p integration_tests.acceptance
3939

4040
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).
4141

42-
See your [Contributiong guide]() on how to get started releasing your connector.
42+
See your [Contributiong guide](../../../contributing-to-airbyte/README.md) on how to get started releasing your connector.
4343

4444
## Read more:
4545

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ In this example, outer.inner.k2 will evaluate to "MyKey is MyValue"
137137
Strings can contain references to previously defined values.
138138
The parser will dereference these values to produce a complete ConnectionDefinition
139139
140-
References can be defined using a *ref(<arg>) string.
140+
References can be defined using a "*ref({arg})" string.
141141
142142
```yaml
143143
key: 1234

docs/contributing-to-airbyte/gradle-cheatsheet.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ We have 3 ways of slicing our builds:
1313
In our CI we run **Build Platform** and **Build Connectors Base**. Then separately, on a regular cadence, we build each connector and run its integration tests.
1414

1515
We split Build Platform and Build Connectors Base from each other for a few reasons:
16+
1617
1. The tech stacks are very different. The Platform is almost entirely Java. Because of differing needs around separating environments, the Platform build can be optimized separately from the Connectors one.
1718
2. We want to the iteration cycles of people working on connectors or the platform faster _and_ independent. e.g. Before this change someone working on a Platform feature needs to run formatting on the entire codebase \(including connectors\). This led to a lot of cosmetic build failures that obfuscated actually problems. Ideally a failure on the connectors side should not block progress on the platform side.
1819
3. The lifecycles are different. One can safely release the Platform even if parts of Connectors Base is failing \(and vice versa\).
@@ -101,18 +102,18 @@ We split Acceptance Tests into 2 different test suites:
101102
* Platform Acceptance Tests: These tests are a coarse test to sanity check that each major feature in the platform. They are run with the following command: `SUB_BUILD=PLATFORM ./gradlew :airbyte-tests:acceptanceTests`. These tests expect to find a local version of Airbyte running. For testing the docker version start Airbyte locally. For an example, see the [acceptance_test script](../../tools/bin/acceptance_test.sh) that is used by the CI. For Kubernetes, see the [accetance_test_kube script](../../tools/bin/acceptance_test_kube.sh) that is used by the CI.
102103
* Migration Acceptance Tests: These tests make sure the end-to-end process of migrating from one version of Airbyte to the next works. These tests are run with the following command: `SUB_BUILD=PLATFORM ./gradlew :airbyte-tests:automaticMigrationAcceptanceTest --scan`. These tests do not expect there to be a separate deployment of Airbyte running.
103104

104-
These tests currently all live in [airbyte-tests](../.././airbyte-tests)
105+
These tests currently all live in [airbyte-tests](https://github.com/airbytehq/airbyte/airbyte-tests)
105106

106107
**Frontend Acceptance Tests**
107108

108-
These are acceptance tests for the frontend. They are run with
109+
These are acceptance tests for the frontend. They are run with
109110
```shell
110111
SUB_BUILD=PLATFORM ./gradlew --no-daemon :airbyte-webapp-e2e-tests:e2etest
111112
```
112-
Like the Platform Acceptance Tests, they expect Airbyte to be running locally. See the [script](https://github.com/airbytehq/airbyte/blob/master/tools/bin/e2e_test.sh) that is used by the CI.
113113

114+
Like the Platform Acceptance Tests, they expect Airbyte to be running locally. See the [script](https://github.com/airbytehq/airbyte/blob/master/tools/bin/e2e_test.sh) that is used by the CI.
114115

115-
These tests currently all live in [airbyte-webapp-e2e-tests](../.././airbyte-webapp-e2e-tests)
116+
These tests currently all live in [airbyte-webapp-e2e-tests](https://github.com/airbytehq/airbyte/airbyte-webapp-e2e-tests)
116117

117118
**Future Work**
118119

@@ -124,11 +125,12 @@ Our story around "integration testing" or "E2E testing" is a little ambiguous. O
124125

125126
All connectors, regardless of implementation language, implement the following interface to allow uniformity in the build system when run from CI:
126127

127-
**Build connector, run unit tests, and build Docker image**:
128+
**Build connector, run unit tests, and build Docker image**:
128129
```shell
129130
./gradlew :airbyte-integrations:connectors:<connector_name>:build
130131
```
131-
**Run integration tests**:
132+
133+
**Run integration tests**:
132134
```shell
133135
./gradlew :airbyte-integrations:connectors:<connector_name>:integrationTest
134136
```
@@ -139,7 +141,7 @@ The ideal end state for a Python connector developer is that they shouldn't have
139141

140142
We're almost there, but today there is only one Gradle command that's needed when developing in Python, used for formatting code.
141143

142-
**Formatting python module**:
144+
**Formatting python module**:
143145
```shell
144146
./gradlew :airbyte-integrations:connectors:<connector_name>:airbytePythonFormat
145147
```

docusaurus/docusaurus.config.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ const config = {
6262
sidebarPath: require.resolve('./sidebars.js'),
6363
editUrl: 'https://github.com/airbytehq/airbyte/blob/master/docs',
6464
path: '../docs',
65-
exclude: ['**/connector-development/config-based/**']
6665
},
6766
blog: false,
6867
theme: {

0 commit comments

Comments
 (0)