docs: fix incorrect decoding command in developer documentation #4241
Conversation
This file contains 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
Signed-off-by: Juwon Hwang (Kevin) <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4241 +/- ##
==========================================
- Coverage 65.69% 65.64% -0.05%
==========================================
Files 197 197
Lines 23540 23540
==========================================
- Hits 15464 15453 -11
- Misses 6968 6977 +9
- Partials 1108 1110 +2 ☔ View full report in Codecov by Sentry. |
zirain
reviewed
Sep 14, 2024
| @@ -91,7 +91,7 @@ A `401` HTTP response code should be returned. | |||
| Get the JWT used for testing request authentication: | |||
|
|
|||
| ```shell | |||
| TOKEN=$(curl https://raw.githubusercontent.com/envoyproxy/gateway/main/examples/kubernetes/jwt/test.jwt -s) && echo "$TOKEN" | cut -d '.' -f2 - | base64 --decode - | |||
There was a problem hiding this comment.
did you test the new command on linux?
There was a problem hiding this comment.
Yes, this command works on Linux. In fact, the existing command only works on Linux, not on mac. The changed command works both.
zirain
approved these changes
Sep 14, 2024
shawnh2
approved these changes
Sep 14, 2024
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.
What type of PR is this?
docs: fix incorrect decoding command in developer documentation
What this PR does / why we need it:
The developer guide documentation contains an incorrect command for decoding JWT tokens. The current example includes an unnecessary
-argument in the base64 command. The correct version omits this extra argument, ensuring the command runs properly. This PR fixes the issue to prevent confusion when following the example.Which issue(s) this PR fixes:
Fixes #4240