Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Troubleshooting documentation #26048

Merged
merged 8 commits into from
May 15, 2023
Merged

Conversation

marcosmarxm
Copy link
Member

@marcosmarxm marcosmarxm commented May 12, 2023

What

  • Add mention to OSS Premium Support
  • Add mention about daily office hour
  • Remove non updated sub-pages
  • Add mention of Premium Support in deploy, connector dev and updgradig pages.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

馃毃 User Impact 馃毃

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 馃毃馃毃 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • 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.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

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.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label May 12, 2023
@marcosmarxm
Copy link
Member Author

@erica-airbyte @johnlafleur updating the troubleshooting page in our docs page. Let me know what do you think about.

I'm removing some sub-pages which weren't updated at all and (I checked in Google Analytics) low traffic.

@marcosmarxm marcosmarxm merged commit d0fa40c into master May 15, 2023
20 checks passed
@marcosmarxm marcosmarxm deleted the marcos/update-trouble-docs branch May 15, 2023 19:52
marcosmarxm added a commit to natalia-miinto/airbyte that referenced this pull request Jun 8, 2023
* remove unused docs and create troubleshooting main page

* add desc

* update our troubleshooting page

* add premium support mention

* update link to daily oh

* add notes of premium support in other pages

* remove ref in local deployment and sidebar
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants