-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
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.
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
chore: fix not-correct lint #5356
chore: fix not-correct lint #5356
Conversation
WalkthroughThe documentation for the Apollo Open API Platform has been updated in both the English and Chinese versions. The URL reference directing users to the location of shell scripts has been corrected from the Changes
Suggested labels
Suggested reviewers
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/zh/portal/apollo-open-api-platform.md (1)
74-74
: Markdown Link Formatting SuggestionTo improve readability and comply with markdownlint (MD034), consider wrapping the bare URL in markdown link syntax. For example, you might update the line to:
* 全部和openapi有关的shell脚本在文件夹 [scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash) 下
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/portal/apollo-open-api-platform.md
(1 hunks)docs/zh/portal/apollo-open-api-platform.md
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/en/portal/apollo-open-api-platform.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/zh/portal/apollo-open-api-platform.md
74-74: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (8)
🔇 Additional comments (1)
docs/zh/portal/apollo-open-api-platform.md (1)
74-74
: Updated Shell Script Directory URL ConfirmedThe URL has been updated to point to the correct folder (
scripts/openapi/bash
) for all OpenAPI-related shell scripts. This change clearly aligns with the PR objective and ensures users are directed to the appropriate location.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Bare URL used
null(MD034, no-bare-urls)
847920f
to
0bb871d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/en/portal/apollo-open-api-platform.md (1)
79-79
: Update URL Reference and Improve Markdown URL Formatting
The URL now correctly points to the OpenAPI bash scripts folder. To further comply with lint rules (MD034: no-bare-urls), consider wrapping the URL in markdown link syntax so that it isn’t flagged as a bare URL.
[static_analysis]-* All the shell scripts related to openapi are in the folder https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash +* All the shell scripts related to openapi are in the folder [https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
79-79: Bare URL used
null(MD034, no-bare-urls)
docs/zh/portal/apollo-open-api-platform.md (1)
74-74
: 更新脚本目录 URL 并优化 Markdown 格式
当前更新后的 URL 正确指向了 OpenAPI 相关的 shell 脚本所在文件夹。建议将裸露的 URL 转换为 Markdown 格式的链接,以符合 lint 规范(MD034: no-bare-urls),从而提高文档的统一性和可读性。
[static_analysis]-* 全部和openapi有关的shell脚本在文件夹 https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash 下 +* 全部和openapi有关的shell脚本在文件夹 [https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash) 下🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/portal/apollo-open-api-platform.md
(1 hunks)docs/zh/portal/apollo-open-api-platform.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/en/portal/apollo-open-api-platform.md
79-79: Bare URL used
null
(MD034, no-bare-urls)
docs/zh/portal/apollo-open-api-platform.md
74-74: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (8)
What's the purpose of this PR
Fix not correct lint for openapi shell scripts
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean test
to make sure this pull request doesn't break anything.CHANGES
log.Summary by CodeRabbit