[DX-1380] Update write-grpc-plugin.md #4681

letzya · 2024-05-24T15:41:04Z

User description

a few small format fixes. yaml code highlight works better with invalid json snippet

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

https://deploy-preview-4681--tyk-docs.netlify.app/docs/nightly/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin

Description

Screenshots (if appropriate)

Checklist

I have added a preview link to the PR description.
I have reviewed the guidelines for contributing to this repository.
I have read the technical guidelines for contributing to this repository.
Make sure you have started your change off our latest master.
I labelled the PR

PR Type

documentation

Description

This PR includes several improvements to the write-grpc-plugin.md documentation:

Changed code block syntax highlighting from JSON to YAML for better readability.
Corrected typos and grammatical errors.
Clarified configuration instructions and examples.
Added backticks around manifest.json and other code elements for better clarity.

Changes walkthrough 📝

Relevant files

Documentation

write-grpc-plugin.md `Improve formatting and clarity in gRPC plugin documentation` tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md Changed code block syntax highlighting from JSON to YAML. Corrected typos and improved grammar. Clarified configuration instructions and examples. Added backticks around `manifest.json` and other code elements for clarity.	+19/-19

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions · 2024-05-24T15:41:39Z

PR Description updated to latest commit (472d279)

github-actions · 2024-05-24T15:41:55Z

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are mostly related to formatting and minor text corrections, which are straightforward to review.
🧪 Relevant tests	No
⚡ Possible issues	No
🔒 Security concerns	No

Code feedback:

relevant file	tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md
suggestion	Consider using consistent terminology for JSON-like structures. Since the actual content is in YAML format, it's better to refer to them as "YAML blocks" or "YAML snippets" instead of using terms like "manifest.json" which could confuse readers. [important]
relevant line	```yaml

relevant file	tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md
suggestion	It's recommended to add a newline at the end of the file to comply with POSIX standards and to avoid potential issues with tools that process text files. [medium]
relevant line	---

github-actions · 2024-05-24T15:42:38Z

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Correct the code block syntax to match the actual content format Correct the code block syntax from `yaml` to `json` for consistency with the actual content format. The configuration snippets are in JSON format, not YAML. tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md [82-85] -```yaml +```json "coprocess_options": { "enable_coprocess": true, "coprocess_grpc_server": "tcp://127.0.0.1:5555", Suggestion importance[1-10]: 10 Why: The suggestion correctly identifies that the configuration snippets are in JSON format and not YAML, ensuring consistency and preventing potential confusion for users.	10
Enhancement	Improve grammar and sentence structure for clarity Update the grammar in the description to improve readability and correct the sentence structure. tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md [92] -A gRPC server can configured under the `coprocess_options` section as follows: +A gRPC server can be configured under the `coprocess_options` section as follows: Suggestion importance[1-10]: 9 Why: The suggestion improves the readability and correctness of the documentation by fixing a grammatical error, making the instructions clearer.	9
Best practice	Use consistent terminology for JSON keys related to HTTP/2 headers Ensure the use of consistent terminology for JSON keys in the documentation to avoid confusion. The key `grpc_authority` should maintain the colon notation as `:authority` if it directly relates to HTTP/2 headers. tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md [98] -- `grpc_authority`: The `authority` header value, defaults to `localhost` if omitted. +- `:authority`: The `authority` header value, defaults to `localhost` if omitted. Suggestion importance[1-10]: 8 Why: The suggestion promotes consistency in terminology, which is important for clarity and correctness, especially when referring to specific HTTP/2 headers.	8

netlify · 2024-05-24T15:43:14Z

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	`472d279`
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/6650b51242c5530008486482
😎 Deploy Preview	https://deploy-preview-4681--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-05-24T15:43:14Z

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	`e9830d6`
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66572abed8dd5300088fe372
😎 Deploy Preview	https://deploy-preview-4681--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dcs3spp

PR LGTM, thanks @letzya I'll merge and release

a few small format fixes. yaml code highlight works better with invalid json snippet

dcs3spp · 2024-05-29T13:19:10Z

/release to release-5.3

tykbot · 2024-05-29T13:19:33Z

Working on it! Note that it can take a few minutes.

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

tykbot · 2024-05-29T13:19:54Z

@dcs3spp Succesfully merged PR

dcs3spp · 2024-05-29T13:20:33Z

/release to release-5.2

tykbot · 2024-05-29T13:21:06Z

Working on it! Note that it can take a few minutes.

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

tykbot · 2024-05-29T13:21:28Z

@dcs3spp Succesfully merged PR

[DX-1380] Update write-grpc-plugin.md (#4681) Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet

dcs3spp · 2024-05-29T13:24:16Z

/release to release-5.1

tykbot · 2024-05-29T13:24:30Z

Working on it! Note that it can take a few minutes.

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

tykbot · 2024-05-29T13:24:49Z

@dcs3spp Succesfully merged PR

[DX-1380] Update write-grpc-plugin.md (#4681) Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet

dcs3spp · 2024-05-29T13:27:32Z

/release to release-5

tykbot · 2024-05-29T13:27:47Z

Working on it! Note that it can take a few minutes.

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

tykbot · 2024-05-29T13:28:09Z

@dcs3spp Succesfully merged PR

[DX-1380] Update write-grpc-plugin.md (#4681) Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet

github-actions bot added the Documentation label May 24, 2024

letzya changed the title ~~Update write-grpc-plugin.md~~ [DX-1380] Update write-grpc-plugin.md May 24, 2024

github-actions bot added the Review effort [1-5]: 2 label May 24, 2024

dcs3spp force-pushed the letzya-patch-formatting branch from 472d279 to 0675ad4 Compare May 24, 2024 16:54

dcs3spp self-requested a review May 29, 2024 13:16

dcs3spp approved these changes May 29, 2024

View reviewed changes

Update write-grpc-plugin.md

e9830d6

a few small format fixes. yaml code highlight works better with invalid json snippet

dcs3spp force-pushed the letzya-patch-formatting branch from 0675ad4 to e9830d6 Compare May 29, 2024 13:16

dcs3spp merged commit 1bd5ec9 into master May 29, 2024
10 checks passed

dcs3spp deleted the letzya-patch-formatting branch May 29, 2024 13:19

tykbot bot pushed a commit that referenced this pull request May 29, 2024

[DX-1380] Update write-grpc-plugin.md (#4681)

7da1d30

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

buger mentioned this pull request May 29, 2024

Merging to release-5.3: [DX-1380] Update write-grpc-plugin.md (#4681) #4693

Merged

tykbot bot pushed a commit that referenced this pull request May 29, 2024

[DX-1380] Update write-grpc-plugin.md (#4681)

841151b

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

buger mentioned this pull request May 29, 2024

Merging to release-5.2: [DX-1380] Update write-grpc-plugin.md (#4681) #4694

Merged

tykbot bot pushed a commit that referenced this pull request May 29, 2024

[DX-1380] Update write-grpc-plugin.md (#4681)

67e8ba5

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

buger mentioned this pull request May 29, 2024

Merging to release-5.1: [DX-1380] Update write-grpc-plugin.md (#4681) #4695

Merged

tykbot bot pushed a commit that referenced this pull request May 29, 2024

[DX-1380] Update write-grpc-plugin.md (#4681)

1ecf618

Update write-grpc-plugin.md a few small format fixes. yaml code highlight works better with invalid json snippet (cherry picked from commit 1bd5ec9)

buger mentioned this pull request May 29, 2024

Merging to release-5: [DX-1380] Update write-grpc-plugin.md (#4681) #4696

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX-1380] Update write-grpc-plugin.md #4681

[DX-1380] Update write-grpc-plugin.md #4681

letzya commented May 24, 2024 •

edited by dcs3spp

Loading

github-actions bot commented May 24, 2024

github-actions bot commented May 24, 2024

github-actions bot commented May 24, 2024

netlify bot commented May 24, 2024 •

edited

Loading

netlify bot commented May 24, 2024 •

edited

Loading

dcs3spp left a comment

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

[DX-1380] Update write-grpc-plugin.md #4681

[DX-1380] Update write-grpc-plugin.md #4681

Conversation

letzya commented May 24, 2024 • edited by dcs3spp Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

Description

Screenshots (if appropriate)

Checklist

PR Type

Description

Changes walkthrough 📝

github-actions bot commented May 24, 2024

github-actions bot commented May 24, 2024

PR Review 🔍

github-actions bot commented May 24, 2024

PR Code Suggestions ✨

netlify bot commented May 24, 2024 • edited Loading

✅ PS. Pls add /docs/nightly to the end of url

netlify bot commented May 24, 2024 • edited Loading

✅ PS. Pls add /docs/nightly to the end of url

dcs3spp left a comment

Choose a reason for hiding this comment

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

dcs3spp commented May 29, 2024

tykbot bot commented May 29, 2024

tykbot bot commented May 29, 2024

letzya commented May 24, 2024 •

edited by dcs3spp

Loading

netlify bot commented May 24, 2024 •

edited

Loading

netlify bot commented May 24, 2024 •

edited

Loading