Make config-based docs accessible through direct link #15662

girarda · 2022-08-15T14:55:13Z

What

Add low-code documentation to https://docs.airbyte.com/connector-development/config-based without adding a link to it in the sidebar.
This will allow user research to use a direct link to the docs without explicitly making it available for the general public.

How

Remove exclude block from docusaurus config
Fix broken links in the docs

🚨 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-15T14:59:37Z

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

@@ -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)


girarda · 2022-08-15T14:59:42Z

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

@@ -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>


girarda · 2022-08-15T15:00:21Z

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

girarda · 2022-08-15T15:00:27Z

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

@@ -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.


girarda · 2022-08-15T15:00:54Z

docusaurus/docusaurus.config.js

@@ -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/**']


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

girarda · 2022-08-15T15:08:45Z

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

@@ -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.


i think docusaurus was interpreting the <> as an html directive. the build step stopped complaining after changing to {arg}

girarda · 2022-08-15T15:09:31Z

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


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


link to github because airbyte-webapp-e2e-tests isn't part of the docs

girarda · 2022-08-15T15:09:47Z

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

@@ -101,18 +102,18 @@ We split Acceptance Tests into 2 different test suites:
 * 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.
 * 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.

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


link to github because airbyte-tests isn't included in the docs

@ryankfu FYI

* fix broken links * include config-based * throw on broken links * fix link * reset

girarda added 2 commits August 15, 2022 07:54

fix broken links

c97b4c3

include config-based

e51db7b

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

throw on broken links

2b22217

girarda commented Aug 15, 2022

View reviewed changes

girarda added 2 commits August 15, 2022 08:01

fix link

3daec03

reset

4516dbd

girarda commented Aug 15, 2022

View reviewed changes

girarda changed the title ~~Alex/lowcodelinks~~ Make config-based docs accessible through direct link Aug 15, 2022

girarda marked this pull request as ready for review August 15, 2022 15:15

girarda requested review from Amruta-Ranade, misteryeo and sherifnada August 15, 2022 15:15

sherifnada approved these changes Aug 15, 2022

View reviewed changes

girarda merged commit 2fd43d4 into master Aug 15, 2022

girarda deleted the alex/lowcodelinks branch August 15, 2022 17:03

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

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

Make config-based docs accessible through direct link (#15662)

f3da7aa

* fix broken links * include config-based * throw on broken links * fix link * reset

evantahler mentioned this pull request Aug 22, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1 #15857

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make config-based docs accessible through direct link #15662

Make config-based docs accessible through direct link #15662

girarda commented Aug 15, 2022 •

edited

Loading

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022

girarda Aug 15, 2022


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

Make config-based docs accessible through direct link #15662

Make config-based docs accessible through direct link #15662

Conversation

girarda commented Aug 15, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

girarda commented Aug 15, 2022 •

edited

Loading