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.

Sign up for GitHub

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

Jump to bottom

Update auth.md #1355

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update auth.md #1355

wants to merge 1 commit into from

Conversation

LikDan
Copy link

@LikDan LikDan commented Sep 9, 2024

No description provided.

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Sep 9, 2024 •
edited
Loading

CLA Signed


The committers listed above are authorized under a signed CLA.

@ejona86
Copy link
Member

ejona86 commented Sep 9, 2024

@arjan-bal, can you review since this is for Go?

arjan-bal
arjan-bal reviewed Sep 10, 2024
View reviewed changes
Copy link
Contributor

@arjan-bal arjan-bal left a comment

Choose a reason for hiding this comment

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

There are separate tables for OAuth and TLS examples, and links for Go seem to be correct in both. I don't think any changes are required here.

content/en/docs/guides/auth.md
[Go Example]: https://github.com/grpc/grpc-go/tree/master/examples/features/encryption
[Go Documentation]: https://github.com/grpc/grpc-go/tree/master/examples/features/encryption#encryption
[Go Example]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication
[Go Documentation]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication#encryption
Copy link
Contributor

Choose a reason for hiding this comment

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

Since there is no #encryption section on the page, this link seems broken.

content/en/docs/guides/auth.md
Comment on lines +216 to +217
[Go Example]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication
[Go Documentation]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication#encryption
Copy link
Contributor

Choose a reason for hiding this comment

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

This table is for language specific TLS examples. So the Go links seems to correctly point to the encryption directory. The table just below this is for OAuth examples, in which the Go row points to the links you've added in this PR.

grpc.io/content/en/docs/guides/auth.md

Lines 224 to 238 in f4a96fb

### Language guides and examples for OAuth token-based authentication
The following table links to examples demonstrating OAuth token-based
authentication and authorization in various languages.
| Language | Example | Documentation |
|----------|-------------------------------------------|-------------------------------|
| C++ | N/A | N/A |
| Go | [Go OAuth Example] | [Go OAuth Documentation] |
| Java | [Java OAuth Example] | [Java OAuth Documentation] |
| Python | [Python OAuth Example] | [Python OAuth Documentation] |
[Go OAuth Example]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication#authentication
[Go OAuth Documentation]: https://github.com/grpc/grpc-go/tree/master/examples/features/authentication#oauth2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arjan-bal arjan-bal arjan-bal left review comments

@Reallyfe Reallyfe Reallyfe approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@LikDan @ejona86 @arjan-bal @Reallyfe