jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2026-01-02 21:02:43 -05:00
Code Issues Packages Projects Releases Wiki Activity

update docs (#2411)

Browse Source
This commit is contained in:
Christophe Duong
2021-03-12 10:01:34 +01:00
committed by GitHub
parent 6abc1cf4ad
commit fd0ec92209
4 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tutorials/building-a-python-source.md
View File

@@ -196,6 +196,8 @@ The template fills in most of the information for the readme for you. Unless the
Open the following file: `airbyte-config/init/src/main/resources/seed/source_definitions.yaml`. You'll find a list of all the connectors that Airbyte displays in the UI. Pattern match to add your own connector. Make sure to generate a new _unique_ UUIDv4 for the `sourceDefinitionId` field. You can get one [here](https://www.uuidgenerator.net/). After you do, run `./gradlew :airbyte-config:init:build` \(this command generates some necessary configuration files\).
Note that for simple and quick testing use cases, you can also do this step [using the UI](../integrations/custom-connectors.md#adding-your-connectors-in-the-ui).
#### Step 12: Add docs
Each connector has its own documentation page. By convention, that page should have the following path: in `docs/integrations/sources/<source-name>.md`. For the documentation to get packaged with the docs, make sure to add a link to it in `docs/SUMMARY.md`. You can pattern match doing that from existing connectors.