Create index.md #1308
Create index.md #1308
Conversation
|
Warning Rate limit exceeded@tangtang-0521 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 23 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughA new markdown file has been added to the documentation. It provides a detailed explanation of the HTNN plugin extension mechanism. The document describes the unified FilterPolicy CRD—highlighting its use of the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md (7)
18-18: Convert Bare URL to Markdown LinkThe GitHub URL on this line is currently presented as a bare URL. For better readability and consistency, consider converting it to a markdown link—for example:
[HTNN GitHub](https://github.com/mosn/htnn).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
18-18: Bare URL used
null(MD034, no-bare-urls)
28-59: Specify Language for Fenced Code BlockThe configuration snippet provided here is in a fenced code block without an explicit language identifier. Adding a language (for example,
yaml) will improve syntax highlighting and clarity.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
28-28: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
67-71: Add Language Identifier to Code BlockFor the code block showcasing the
Pluginstruct, specifying a language (such asgo) will enable proper syntax highlighting and enhance readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
67-67: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
78-78: Review Verb Modification in Chinese TextConsider verifying the phrasing in this line regarding the adverbial usage. For instance, re-evaluate whether “高效的开发效率” might be more accurately phrased as “高效地开发” or an alternative expression that better conforms to Chinese grammatical conventions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：高"地"开发
Context: ...懂网关的实现细节。由于插件开发的门槛降低了，开发者能够更加聚焦业务问题，取得更高的开发效率。 ## Validate via Protobuf and Go ...(wb4)
93-95: Verify Terminology ConsistencyThe term “补齐” is used to describe bridging the capability gap between Istio and Gateway API. Please confirm that this term correctly conveys the intended meaning; if there’s a risk of misinterpretation (as hinted by language tools), a minor clarification might help.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~94-~94: 您的意思是“"不"齐”？
Context: ...licy 把 CORS 的能力加回来。Native Plugin 的能力不仅限于补齐 istio 现有能力和 Gateway API 之间的间隙。istio 官方...(BU)
104-108: Use Semantic Headings Instead of EmphasisLines 104 and 106 use emphasis to denote section titles (e.g., "欢迎大家加入社区与我们交流" and "GitHub"). For improved document semantics and accessibility, consider using markdown headings (for example,
## 欢迎大家加入社区与我们交流and## GitHub).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
104-104: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
106-106: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
108-108: Bare URL used
null(MD034, no-bare-urls)
108-108: Convert Bare URL to Markdown LinkThe URL on line 108 is presented in a bare format. Converting it into a markdown link (e.g.,
[HTNN GitHub](https://github.com/mosn/htnn)) would enhance the document’s readability and adhere to markdown best practices.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
108-108: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md
[uncategorized] ~11-~11: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：好"地"插
Context: ...0-tps-1080-459.jpg)" --- # HTNN 如何斟酌出更好的插件扩展机制 在设计插件扩展机制时，HTNN 关注两点： 1. 扩展性尽可能...
(wb4)
[uncategorized] ~78-~78: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：高"地"开发
Context: ...懂网关的实现细节。由于插件开发的门槛降低了，开发者能够更加聚焦业务问题，取得更高的开发效率。 ## Validate via Protobuf and Go ...
(wb4)
[uncategorized] ~94-~94: 您的意思是“"不"齐”？
Context: ...licy 把 CORS 的能力加回来。Native Plugin 的能力不仅限于补齐 istio 现有能力和 Gateway API 之间的间隙。istio 官方...
(BU)
🪛 markdownlint-cli2 (0.17.2)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md
18-18: Bare URL used
null
(MD034, no-bare-urls)
28-28: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
67-67: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
104-104: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
106-106: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
108-108: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (1)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md (1)
1-9: Front Matter Formatting and Metadata ValidityThe front matter is well-structured and includes all the necessary metadata (title, authorlink, description, categories, tags, date, cover). Please double-check that the cover URL and date are in line with your site's formatting standards.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md (6)
13-20: Introduction & URL Formatting
The introductory section succinctly outlines the two core objectives. However, the GitHub URL on line 19 is written as a bare URL. For consistency and improved readability, consider converting it into a markdown link.Example change:
-**GitHub**: https://github.com/mosn/htnn +**GitHub**: [https://github.com/mosn/htnn](https://github.com/mosn/htnn)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
19-19: Bare URL used
null(MD034, no-bare-urls)
29-60: Code Fence for YAML Example
The fenced code block presents a YAML snippet for a typical FilterPolicy. To enhance syntax highlighting and readability, please specify the language (e.g.,yaml) for the code block.Example change:
-``` +```yaml(Ensure that the closing fence remains unchanged.)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
29-29: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
69-73: Code Fence for Plugin Struct
The code block defining the Plugin struct would benefit from a language identifier (likelygo) to improve clarity and enable proper syntax highlighting.Example change:
-``` +```go(Remember to update the closing fence accordingly.)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
69-69: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
75-80: Plugin Development Explanation
The explanation of plugin decoupling is well-articulated. As a minor nitpick, reconsider the phrasing on line 80 regarding "高效的开发效率"—using an adverbial form (for example, "高效地开发") might more precisely convey the intended meaning.🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：高"地"开发
Context: ...懂网关的实现细节。由于插件开发的门槛降低了，开发者能够更加聚焦业务问题，取得更高的开发效率。 ## Validate via Protobuf and Go ...(wb4)
90-100: Run in Istiod or Envoy Section
This portion of the document clearly distinguishes between Native Plugins and Go Plugins and their deployment contexts. On line 96, please double-check that the term "补齐" is the intended word—it might be worth confirming that it accurately conveys the desired meaning rather than implying any inadvertent error.🧰 Tools
🪛 LanguageTool
[uncategorized] ~96-~96: 您的意思是“"不"齐”？
Context: ...licy 把 CORS 的能力加回来。Native Plugin 的能力不仅限于补齐 istio 现有能力和 Gateway API 之间的间隙。istio 官方...(BU)
106-112: Community Call-to-Action Formatting
The final section uses bold text to highlight "欢迎大家加入社区与我们交流" and "GitHub." However, markdownlint recommends using proper heading syntax instead of emphasis for titles to improve document structure. Additionally, the GitHub URL on line 111 is a bare URL; formatting it as a markdown link would enhance consistency.Example changes:
-**GitHub** +## GitHuband
-https://github.com/mosn/htnn +[https://github.com/mosn/htnn](https://github.com/mosn/htnn)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
108-108: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
111-111: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md
[uncategorized] ~11-~11: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：好"地"插
Context: ...0-tps-1080-459.jpg)" --- # HTNN 如何斟酌出更好的插件扩展机制 在设计插件扩展机制时，HTNN 关注两点： 1. 扩展性尽可能...
(wb4)
[uncategorized] ~80-~80: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：高"地"开发
Context: ...懂网关的实现细节。由于插件开发的门槛降低了，开发者能够更加聚焦业务问题，取得更高的开发效率。 ## Validate via Protobuf and Go ...
(wb4)
[uncategorized] ~96-~96: 您的意思是“"不"齐”？
Context: ...licy 把 CORS 的能力加回来。Native Plugin 的能力不仅限于补齐 istio 现有能力和 Gateway API 之间的间隙。istio 官方...
(BU)
🪛 markdownlint-cli2 (0.17.2)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md
19-19: Bare URL used
null
(MD034, no-bare-urls)
29-29: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
69-69: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
106-106: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
108-108: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
111-111: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (6)
content/zh/blog/htnn-how-to-deliberate-on-a-better-plugin-extension-mechanism/index.md (6)
1-9: Front Matter Review
The YAML front matter is comprehensive, providing key metadata such as title, authorlink, description, categories, tags, date, and cover image. Please ensure these values (especially the date and tag formats) are consistent with your site’s conventions.
11-12: Title Clarity
The title is clear and descriptive, setting the stage for the content.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：好"地"插
Context: ...0-tps-1080-459.jpg)" --- # HTNN 如何斟酌出更好的插件扩展机制 在设计插件扩展机制时，HTNN 关注两点： 1. 扩展性尽可能...(wb4)
21-28: FilterPolicy CRD Section
This section clearly explains the purpose of the FilterPolicy CRD and its role in unifying network policy configurations. The rationale provided is easy to follow.
62-67: FilterPolicy Fields Explanation
This segment concisely explains the two core fields—targetRef and filters—which is both informative and clearly presented.
82-89: Validation via Protobuf and Go
This section effectively details the rationale behind using Protobuf and Go for pre-validating plugin configurations. The detailed explanation supports the design decisions well.
102-105: Summary Section
The summary succinctly reiterates the key points and reinforces the design objectives. The content is both clear and compelling.
Summary by CodeRabbit