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

Initial Oracle configuration docs #872

Merged
merged 3 commits into from
Feb 5, 2025
Merged

Conversation

GavinRay97
Copy link
Member

Description 📝

Adds configuration documentation for the Oracle connector

Quick Links 🚀

Assertion Tests 🤖

@hasura-bot
Copy link
Contributor

@GavinRay97 Thanks for your PR! I've assigned @robertjdominguez to review it.

@hasura-bot
Copy link
Contributor

hasura-bot commented Feb 4, 2025

DX: Assertion Testing

✅ Diff

The PR provides comprehensive documentation about the Oracle connector's configuration. It clearly describes each property with examples, making the setup process easy to understand for new users. However, it is recommended to add a newline at the end of the _category_.json file to follow best practices. Furthermore, the descriptions for the tables and functions are left as empty strings, which is not ideal; providing even a brief description may improve understanding. Lastly, consider whether mentioning MySQL in the 'JDBC Properties' section may cause confusion, as this section pertains to Oracle.

✅ Integrated

The new connector information appears to integrate well with the overall documentation structure. It is neatly categorized under the Oracle section, which is correctly positioned in the sidebar. The added documentation on configuration aligns with the established patterns and will likely enhance the usability of the entire documentation set for users interested in integrating Oracle databases. However, ensure that cross-referencing between this section and others is present if any related concepts or instructions exist elsewhere in the documentation.

Copy link

cloudflare-workers-and-pages bot commented Feb 4, 2025

Deploying ddn-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 90c0ad9
Status:⚡️  Build in progress...

View logs

@robertjdominguez robertjdominguez enabled auto-merge (squash) February 5, 2025 13:28
Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

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

Thanks, @GavinRay97!

I pushed a small commit for the review; this just adds a bit of context to the start of the doc. Additionally, when the How to build with Oracle tutorial is ready, we'll need to link to it in the index like the existing pages for Postgres, Mongo, and ClickHouse.

@robertjdominguez robertjdominguez merged commit 332137f into main Feb 5, 2025
3 of 4 checks passed
@robertjdominguez robertjdominguez deleted the gavin/oracle-conf-docs branch February 5, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants