Fix minor typo and unify Markdown table formatting#10723
Open
gitxar7 wants to merge 7 commits intowso2:masterfrom
Open
Fix minor typo and unify Markdown table formatting#10723gitxar7 wants to merge 7 commits intowso2:masterfrom
gitxar7 wants to merge 7 commits intowso2:masterfrom
Conversation
Corrected grammatical errors and improved sentence structure for clarity.
Improve grammar in about-this-release.md
Updated formatting for consistency and corrected capitalization in the mock service URL.
|
|
WalkthroughDocumentation edits across get-started guides and release notes: grammar and punctuation fixes, reworded introductory sentences, expanded Federated Gateways list to include Kong Gateway and Envoy Gateway, and replacement of an HTML API-details table with a Markdown table. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Corrected grammatical errors and improved clarity in the architecture documentation.
Fix grammar and clarity in apim-architecture.md
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/get-started/apim-architecture.md`:
- Line 3: Change the phrase "can works with" to "can work with" in the sentence
"WSO2 API Manager and the various components that it can works with." Locate
that exact sentence in the en/docs/get-started/apim-architecture.md content and
replace "can works" with the correct base-verb form "can work" so the sentence
reads "...and the various components that it can work with."
- Line 43: The phrase "OAuth 2.0 based security" in the sentence in
apim-architecture.md should use a hyphen for the compound adjective—update the
text to "OAuth 2.0-based security" so the compound modifier correctly precedes
the noun; locate the sentence containing "In addition to using the built-in Key
Manager as the IDP..." and replace the substring "OAuth 2.0 based security" with
"OAuth 2.0-based security".
- Line 53: The phrase "rate limiting" in the sentence "The Data Plane is where
the created API is exposed to the public consumers and acts as the proxy for API
calls. This also provides additional capabilities such as enforcing security,
rate limiting, etc." should be hyphenated as a compound modifier—change "rate
limiting" to "rate-limiting" so the sentence reads "...such as enforcing
security, rate-limiting, etc." and preserve existing punctuation and casing.
- Line 11: Summary: Hyphenate the compound modifier "rate-limiting policies."
Fix: Edit the sentence containing the phrase "rate limiting policies" (the
sentence beginning "It consists of portals (Publisher, Developer Portal and
Service Catalog) ...") and change "rate limiting policies" to "rate-limiting
policies" so the compound adjective is hyphenated correctly.
| # Architecture and Key Components | ||
|
|
||
| The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can work together with. | ||
| The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can works with. |
There was a problem hiding this comment.
Fix grammar: “can works” → “can work.”
“Can” should pair with base verb form.
✅ Suggested edit
-The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can works with.
+The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can work with. 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can works with. | |
| The diagram below is a high-level snapshot of WSO2 API Manager and the various components that it can work with. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/get-started/apim-architecture.md` at line 3, Change the phrase "can
works with" to "can work with" in the sentence "WSO2 API Manager and the various
components that it can works with." Locate that exact sentence in the
en/docs/get-started/apim-architecture.md content and replace "can works" with
the correct base-verb form "can work" so the sentence reads "...and the various
components that it can work with."
| ## API Control Plane | ||
|
|
||
| The API Control Plane is where API creation and API management takes place. It consists of portals (Publisher, Developer Portal and Service Catalog) for users to create and manage APIs, implement rate limiting policies, monitor, and monetize etc. The API Control Plane consists of a Key manager component for API security validation and API key generation. It also provides a set of APIs to interact with external tools like API Controller. The API Control Plane includes API Analytics dashboards, displaying various business insights. | ||
| The API Control Plane is where API creation and API management takes place. It consists of portals (Publisher, Developer Portal and Service Catalog) for users to create and manage APIs, implement rate limiting policies, monitor, and monetize. The API Control Plane consists of a Key Manager component for API security validation and API key generation. It also provides a set of APIs to interact with external tools like API Controller. The API Control Plane includes API Analytics dashboards, displaying various business insights. |
There was a problem hiding this comment.
Hyphenate compound modifier: “rate-limiting policies.”
Use a hyphen when a compound adjective precedes a noun.
✅ Suggested edit
-...implement rate limiting policies, monitor, and monetize.
+...implement rate-limiting policies, monitor, and monetize.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| The API Control Plane is where API creation and API management takes place. It consists of portals (Publisher, Developer Portal and Service Catalog) for users to create and manage APIs, implement rate limiting policies, monitor, and monetize. The API Control Plane consists of a Key Manager component for API security validation and API key generation. It also provides a set of APIs to interact with external tools like API Controller. The API Control Plane includes API Analytics dashboards, displaying various business insights. | |
| The API Control Plane is where API creation and API management takes place. It consists of portals (Publisher, Developer Portal and Service Catalog) for users to create and manage APIs, implement rate-limiting policies, monitor, and monetize. The API Control Plane consists of a Key Manager component for API security validation and API key generation. It also provides a set of APIs to interact with external tools like API Controller. The API Control Plane includes API Analytics dashboards, displaying various business insights. |
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Use a hyphen to join words.
Context: ...o create and manage APIs, implement rate limiting policies, monitor, and monetize...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/get-started/apim-architecture.md` at line 11, Summary: Hyphenate the
compound modifier "rate-limiting policies." Fix: Edit the sentence containing
the phrase "rate limiting policies" (the sentence beginning "It consists of
portals (Publisher, Developer Portal and Service Catalog) ...") and change "rate
limiting policies" to "rate-limiting policies" so the compound adjective is
hyphenated correctly.
| The Key Manager performs scope validation as well. It could also generate JWT tokens to pass end-user attributes to the backend, if configured. | ||
|
|
||
| In addition to using the built-in Key Manager as the IDP, WSO2 API Control Plane also supports integrating with third-party identity providers such as Okta, Auth0, KeyCloak, etc., for OAuth 2.0 based security for APIs. | ||
| In addition to using the built-in Key Manager as the IDP, WSO2 API Control Plane also supports integrating with third-party identity providers such as Okta, Auth0, Keycloak, etc., for OAuth 2.0 based security for APIs. |
There was a problem hiding this comment.
Hyphenate “OAuth 2.0-based security.”
Compound adjective before noun.
✅ Suggested edit
-...for OAuth 2.0 based security for APIs.
+...for OAuth 2.0-based security for APIs.🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: Use a hyphen to join words.
Context: ...ta, Auth0, Keycloak, etc., for OAuth 2.0 based security for APIs. #### API Analy...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/get-started/apim-architecture.md` at line 43, The phrase "OAuth 2.0
based security" in the sentence in apim-architecture.md should use a hyphen for
the compound adjective—update the text to "OAuth 2.0-based security" so the
compound modifier correctly precedes the noun; locate the sentence containing
"In addition to using the built-in Key Manager as the IDP..." and replace the
substring "OAuth 2.0 based security" with "OAuth 2.0-based security".
| ## Data Plane | ||
|
|
||
| The Data Plane is where the created API is exposed to the public consumers and acts as the proxy for API calls. This also provides additional capabilities such as enforcing security, rate limiting etc. | ||
| The Data Plane is where the created API is exposed to the public consumers and acts as the proxy for API calls. This also provides additional capabilities such as enforcing security, rate limiting, etc. |
There was a problem hiding this comment.
Hyphenate compound modifier: “rate-limiting.”
✅ Suggested edit
-...enforcing security, rate limiting, etc.
+...enforcing security, rate-limiting, etc. 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| The Data Plane is where the created API is exposed to the public consumers and acts as the proxy for API calls. This also provides additional capabilities such as enforcing security, rate limiting, etc. | |
| The Data Plane is where the created API is exposed to the public consumers and acts as the proxy for API calls. This also provides additional capabilities such as enforcing security, rate-limiting, etc. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/get-started/apim-architecture.md` at line 53, The phrase "rate
limiting" in the sentence "The Data Plane is where the created API is exposed to
the public consumers and acts as the proxy for API calls. This also provides
additional capabilities such as enforcing security, rate limiting, etc." should
be hyphenated as a compound modifier—change "rate limiting" to "rate-limiting"
so the sentence reads "...such as enforcing security, rate-limiting, etc." and
preserve existing punctuation and casing.
Updated wording for clarity and consistency throughout the document.
Fix minor grammar and formatting issues in Deployment Patterns guide
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.
This PR addresses a couple of minor issues in the Quick Start Guide Markdown file:
These changes improve readability and ensure the Markdown renders consistently across different platforms.
Summary by CodeRabbit