Fix broken external links in clients, vectors/s3, and dotnet SDK recipes - #552
Open
claudespice wants to merge 1 commit into
Open
Fix broken external links in clients, vectors/s3, and dotnet SDK recipes#552claudespice wants to merge 1 commit into
claudespice wants to merge 1 commit into
Conversation
Repo-wide link sweep of all 460 README URLs found four dead targets: Arrow moved its Java docs out of /docs/java/, AWS moved the S3 Vectors page under /s3/features/, and the .NET NuGet package is SpiceAI, not SpiceAI.Client (which is what the sample's csproj already references).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found by HTTP-checking every URL in every cookbook README (460 unique URLs; 297 non-Spice). Four returned a genuine 404. Grouped into one PR because they are one issue class — an external target that moved — and each fix is a single line.
clients/java,clients/scalaarrow.apache.org/docs/java/reference/.../FlightSqlClient.htmlvectors/s3aws.amazon.com/s3/vectors/client-sdk/spice-dotnet-sdk-samplenuget.org/packages/SpiceAI.ClientApache Arrow —
clients/java,clients/scalaArrow retired the
/docs/java/tree; Java docs now live at/java/. The old link also pointed at theFlightSqlClientjavadoc while the link text reads "Apache Arrow Flight SQL JDBC" — and both recipes actually depend on the JDBC driver, not the Java client:clients/java/pom.xml→org.apache.arrow:flight-sql-jdbc-driverclients/scala/build.sbt→"org.apache.arrow" % "flight-sql-jdbc-driver" % "19.0.0"Repointed both to
https://arrow.apache.org/java/current/flight_sql_jdbc_driver.html, which matches the link text and the dependency.Amazon S3 Vectors —
vectors/s3AWS moved the page under
/s3/features/. Repointed tohttps://aws.amazon.com/s3/features/vectors/. (The other S3 Vectors links in this recipe point atspiceai.org/docs/components/vectors/s3_vectorsand already resolve.)NuGet package —
client-sdk/spice-dotnet-sdk-sampleThe README links
SpiceAI.Client, which does not exist on NuGet. The sample's own project file already references the real package:Repointed to
https://www.nuget.org/packages/SpiceAI.Verification
Remaining non-200s in the sweep were all checked and are not defects: bot-blocked hosts returning 403 (
dev.mysql.com,platform.openai.com,x.ai,npmjs.com,timeanddate.com), and intentional placeholders or non-browsable endpoints (api.company.com,your-org.atlassian.net,github.com/user/repo/...,api.tvmaze.com/premium,helm.ngc.nvidia.com/nvidia, thehuggingface.co/.../resolve/mainBASE_URLvariable, and URLs embedded in sample JSON output).