docs: fix org-less links, wrong artifact badges, stale class/package names, and Maven Central claim - #248
Open
ZayanKhan-12 wants to merge 5 commits into
Open
Conversation
github.com/grpc-java-contrib/issues is missing the salesforce org segment and 404s; the anchors used underscores where GitHub slugs the 'Creating a Pull Request' heading with hyphens. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The badges referenced the grpc-contrib artifact rather than this module's grpc-testing-contrib (published on Central; verified), and the documented @rule class is GrpcContextRule - no GrpcContext class exists in the module. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
maven-badges.herokuapp.com returns 404 since the Heroku free-tier shutdown; use shields.io Maven Central badges linking to central.sonatype.com. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The module's subpackages are context, instancemode, interceptor, and xfcc; no session package exists. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
com.salesforce.servicelibs artifacts (grpc-contrib, grpc-spring, grpc-testing-contrib, jprotoc) are published on Maven Central; the 'clone and build it yourself' guidance predates that. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement. |
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
2 participants
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.
Five commits, all documentation (six .md files):
github.com/grpc-java-contrib/issues) are missing thesalesforce/org segment and 404; the in-page anchors used#creating_a_pull_requestwhere GitHub slugs the heading with hyphens.grpc-contribartifact instead of this module'sgrpc-testing-contrib(published on Central — verified), and the documented@Ruleclass isGrpcContextRule; noGrpcContextclass exists in the module.maven-badges.herokuapp.combadge images have returned 404 since the Heroku free-tier shutdown; replaced with shields.io badges (verified 200) linking to central.sonatype.com.sessionsubpackage bullet; the module's subpackages arecontext,instancemode,interceptor, andxfcc.com.salesforce.servicelibsartifacts are published on Maven Central (javadoc.io/Central verified).Verification: class/package names checked against the source tree; artifact availability and badge URLs curl-verified.
mvn testcannot complete on this machine on unmodified master either — the protobuf plugin requires ajprotoc:exe:osx-aarch_64protoc plugin binary that was never published for Apple Silicon (identical failure with and without this diff, which touches only markdown).Prepared with AI assistance (Claude).