Fix link for referencing existing SQL Server resources #198
Conversation
Updated the link for referencing existing resources in SQL Server documentation.
There was a problem hiding this comment.
Pull request overview
This PR fixes a broken documentation link in the SQL Server integration documentation. The old link pointed to a non-existent app-host-overview.md file, which has been replaced with a link to the external parameters documentation that covers connection strings.
Key changes:
- Updated broken link from
app-host-overview.md#reference-existing-resourcestoexternal-parameters/#connection-string-values
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| <Aside type="tip"> | ||
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/app-host-overview.md#reference-existing-resources). | ||
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/external-parameters/#connection-string-values). |
There was a problem hiding this comment.
The new link points to the "Connection string values" section which is appropriate for the AddConnectionString method. However, other similar documentation pages (mysql.mdx, oracle.mdx, mongodb.mdx) use a different link: /get-started/resources/ for the same purpose. For consistency across the documentation, consider using the same link pattern. The /get-started/resources/ page provides a higher-level overview of working with resources, while external-parameters focuses specifically on connection strings—both are relevant, but consistency would help users navigate the docs more predictably.
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/external-parameters/#connection-string-values). | |
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](/get-started/resources/). |
There was a problem hiding this comment.
I don't believe the /get-started/resources/ is an appropriate link. It does not provide additional guidance for how to best utilize AddConnectionString.
|
|
||
| <Aside type="tip"> | ||
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/app-host-overview.md#reference-existing-resources). | ||
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/external-parameters/#connection-string-values). |
There was a problem hiding this comment.
There's another instance of the same broken link in efcore/sql-server.mdx at line 74 that also references the non-existent app-host-overview.md file. This file should be updated with the same fix for consistency.
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/external-parameters/#connection-string-values). | |
| If you'd rather connect to an existing SQL Server, call `AddConnectionString` instead. For more information, see [Reference existing resources](../../fundamentals/external-parameters/#connection-strings). |
There was a problem hiding this comment.
The #connection-strings markdown header pointer does not exist on the fundamentals/external-parameters/ page. #connection-string-values does have a corresponding header though.
1 participant
Unsure if this is the correct link. Was exploring the docs and found that the previous link returned a 404.
Updated to point at this external parameters doc page instead of the previous app-host-overview page which may not exist any longer.
Updated the link for referencing existing resources in SQL Server documentation.