Skip to content

Re-ignore documentation structure check for the time being #35458

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Re-ignore documentation structure check for the time being #35458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e57e1
comment out documentation structure check
erohmensing Feb 20, 2024
2b0d724
generate docs
erohmensing Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airbyte-ci/connectors/connectors_qa/src/connectors_qa/checks/documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,6 @@ def _run(self, connector: Connector) -> CheckResult:
ENABLED_CHECKS = [
CheckMigrationGuide(),
CheckDocumentationExists(),
CheckDocumentationStructure(),
# CheckDocumentationStructure(), # Disabled as many are failing - we either need a big push or to block everyone. See https://github.com/airbytehq/airbyte/commit/4889e6e024d64ba0e353611f8fe67497b02de190#diff-3c73c6521bf819248b3d3d8aeab7cacfa4e8011f9890da93c77da925ece7eb20L262
CheckChangelogEntry(),
]
5 changes: 0 additions & 5 deletions docs/contributing-to-airbyte/resources/qa-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ This document should contain a section for each breaking change, in order of the
*Applies to the following connector languages: java, low-code, python*

The user facing connector documentation should be stored under `./docs/integrations/<connector-type>s/<connector-name>.md`.
### Connectors documentation follows our guidelines
*Applies to the following connector types: source, destination*
*Applies to the following connector languages: java, low-code, python*

The user facing connector documentation should follow the guidelines defined in the [documentation standards](https://hackmd.io/Bz75cgATSbm7DjrAqgl4rw).
### Connectors must have a changelog entry for each version
*Applies to the following connector types: source, destination*
*Applies to the following connector languages: java, low-code, python*
Expand Down