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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix refs to Python CDK manifest yaml #48576

Merged
merged 6 commits into from
Nov 20, 2024

Conversation

aaronsteers
Copy link
Collaborator

@aaronsteers aaronsteers commented Nov 20, 2024

What

Fix docs build failures:

Slack thread: https://airbytehq-team.slack.com/archives/C032Y32T065/p1732034232793509

Also disables CDK Sphinx builds. We expect this is being replaced with pdoc docs.

How

Review guide

User Impact

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Nov 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Nov 20, 2024 6:52pm

@aaronsteers aaronsteers marked this pull request as ready for review November 20, 2024 17:27
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Nov 20, 2024
@aaronsteers
Copy link
Collaborator Author

Another error:

image

Working on it...

@octavia-squidington-iii octavia-squidington-iii added the CDK Connector Development Kit label Nov 20, 2024
Copy link
Contributor

@natikgadzhi natikgadzhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pre-approving to unblock, the direction is good here.

To follow up, please create an issue and assign it to me to actually request the yaml file from the repo at build time, so we don't have to sync the copy of the file here.

@natikgadzhi
Copy link
Contributor

@aaronsteers for the second build error — it's fine to link to the neighboring repo I think.

@aaronsteers aaronsteers merged commit 0727e44 into master Nov 20, 2024
28 checks passed
@aaronsteers aaronsteers deleted the aj/docs/fix-cdk-manifest-yml-refs branch November 20, 2024 18:53
@aaronsteers
Copy link
Collaborator Author

@natikgadzhi - Thanks for the review. I've confirmed that merging this resolved the build failures. I ended up using your suggestion of copying back the yaml file that was imported. We don't support https imports. There's a potential path to do so here but it's non-trivial and I didn't want to introduce new factors or potential security considerations in this fix.

I'll open a new issue as requested and assign to you.

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 CDK Connector Development Kit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants