Update and restructure Oracle integration docs #182
Conversation
…ient integration.
There was a problem hiding this comment.
Pull request overview
This pull request restructures the Oracle integration documentation to improve accessibility for beginners while maintaining comprehensive reference information. The single monolithic document has been split into three focused documents: a getting started guide, a hosting integration reference, and a client integration reference.
Key changes:
- Split documentation into three focused documents (get-started, host, and client)
- Added multi-language support (C#, Python, JavaScript) in the getting started guide
- Updated navigation structure and links to reflect the new document organization
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/frontend/src/data/integration-docs.json |
Updated NuGet package documentation links to point to the new getting started guide |
src/frontend/src/content/docs/integrations/databases/efcore/overview.mdx |
Updated Oracle link to point to the client reference page |
src/frontend/src/content/docs/integrations/databases/efcore/oracle/oracle-host.mdx |
New hosting integration reference with container configuration and non-.NET examples |
src/frontend/src/content/docs/integrations/databases/efcore/oracle/oracle-get-started.mdx |
New getting started guide with multi-language support for C#, Python, and JavaScript |
src/frontend/src/content/docs/integrations/databases/efcore/oracle/oracle-client.mdx |
Restructured client reference focusing on Entity Framework Core integration |
src/frontend/src/content/docs/integrations/databases/efcore/oracle.mdx |
Deleted original monolithic document |
src/frontend/config/sidebar/integrations.topics.ts |
Updated sidebar navigation to show Oracle subsections and removed duplicate entry |
Comments suppressed due to low confidence (2)
src/frontend/src/content/docs/integrations/databases/efcore/oracle/oracle-client.mdx:82
- Missing semicolon at the end of the statement. The line should end with a semicolon for consistency with C# syntax.
src/frontend/src/content/docs/integrations/databases/efcore/oracle/oracle-client.mdx:197 - Inconsistent formatting compared to line 197. Line 197 uses "or" while this line uses "—" (em dash). For consistency, both should use the same separator format throughout the document.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| description="Entity Framework Core integration for Oracle Database" | ||
| icon={oracleIcon} | ||
| href="/integrations/databases/efcore/oracle/" | ||
| href="/integrations/databases/efcore/oracle/oracle-client/" |
There was a problem hiding this comment.
Inconsistent entry points for Oracle documentation. The overview page links to /integrations/databases/efcore/oracle/oracle-client/ while the integration-docs.json (which handles NuGet package links) points to /integrations/databases/efcore/oracle/oracle-get-started/. For a better user experience, both should link to the same entry point, preferably the getting started guide for newcomers.
| href="/integrations/databases/efcore/oracle/oracle-client/" | |
| href="/integrations/databases/efcore/oracle/oracle-get-started/" |
| // Parse the connection URI | ||
| // Format: oracle://username:password@host:port/service_name | ||
| const url = require('url'); | ||
| const parsedUri = new url.URL(connectionUri); |
There was a problem hiding this comment.
The variable connectionUri is used but not defined in this code example. The example should either show how to obtain this variable (e.g., from environment variables using process.env.ORACLEDB_URI) or include it in the variable declarations shown earlier in the section.
| # Parse the connection URI | ||
| # Format: oracle://username:password@host:port/service_name | ||
| import re | ||
| match = re.match(r'oracle://([^:]+):([^@]+)@([^:]+):(\d+)/(.+)', connection_uri) |
There was a problem hiding this comment.
The variable connection_uri is used but not defined in this code example. The example should either show how to obtain this variable (e.g., from environment variables using os.getenv("ORACLEDB_URI")) or include it in the variable declarations shown earlier in the section.
|
|
||
| ## Next steps | ||
|
|
||
| Now, that you have an Aspire app with Oracle integrations up and running, you can use the following reference documents to learn how to configure and interact with the Oracle resources: |
There was a problem hiding this comment.
Unnecessary comma after "Now". The sentence should read "Now that you have" without a comma between "Now" and "that".
| Now, that you have an Aspire app with Oracle integrations up and running, you can use the following reference documents to learn how to configure and interact with the Oracle resources: | |
| Now that you have an Aspire app with Oracle integrations up and running, you can use the following reference documents to learn how to configure and interact with the Oracle resources: |
1 participant
The existing Oracle integration document is comprehensive but difficult for beginners. This PR is intended to keep the comprehensive information but make it easier for those who want to get going quickly. I've used Copilot to propagate changes from the new PostgreSQL documents to the Oracle ones.
This PR: