Docs: Tutorials formatting + from scratch connector tutorial cleanup #33839
Conversation
- Updated the python code samples to be valid (introduce log_error earlier) - Updated the acceptance test documentation to `airbyte-ci`.
This commit renames Standard Tests mentions to Connector Acceptance Tests in the python souce connector tutorial.
- Fixed a typo - Removed redundant git manipulations - Clarified Generic Source template usage - Linked Python CDK docs.
- Reworded the contributions warning. - Made a clickable link to the community Slack channel - General formatting cleanup - Updated the link to examples (exchanges API migrated to low code)
- Updated Python CDK readme to match it's docs (docs/connector-development/cdk-python/README.md)
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
- This commit just runs prettier against all files in `tutorials`. - Also, fixed admonition styles (`:::info`) where prettier broke them. - And fixed a connector testing step to refer to CATS
natikgadzhi
added
area/documentation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
|
Warning Soft code freeze is in effect until 2024-01-02. Please avoid merging to master. #freedom-and-responsibility |
| @@ -2,24 +2,26 @@ | |||
|
|
|||
| ## Summary | |||
|
|
|||
| This article provides a checklist for how to create a Java destination. Each step in the checklist has a link to a more detailed explanation below. | |||
| This article provides a checklist for how to create a Java destination. Each step in the checklist | |||
| has a link to a more detailed explanation below. | |||
There was a problem hiding this comment.
Most likely a prettier -w pass with 100 desired line width. I'm not strongly attached to this approach — I personally like linted markdown to comply to certain width, especially when there are a lot of contibutors, but functionally, same thing.
|
Caveat: when we merge this, I need to update the engineering onboarding check-list, because it links to the old the-hard-way guide URL. Also, consider making them linked to the sidebar again. |
| @@ -1,22 +1,29 @@ | |||
| # Step 8: Test Connector | |||
| # Step 8: Test the Connector | |||
There was a problem hiding this comment.
nit: should the file name be test-the-connector.md?
|
@natikgadzhi let's ship this one? |
What
This is a follow-up for #33822. It formats
tutorials/**/*.mdas an experiment with Prettier, and moves the onboarding "build connnector the hard way" tutorial in it's own subdirectory, and fixes a few inconsistencies.Why
I'm not strongly attached to markdown linting and formatting, but I would love to make things nicer for us overall, and I see quite a lot of work that we can do to make both writing, maintaining, and contributing to Airbyte documentation a better experience.
How
Next steps
Content changes in Tutorials
Housekeeping in Docs
summary..gitbook.