-
Notifications
You must be signed in to change notification settings - Fork 2
chore: remove outdated ConfigAuthenticator #28
base: master
Are you sure you want to change the base?
Conversation
|
@codecov-ai-reviewer review |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Walkthrough更新中英文配置文档:移除 ConfigAuthenticator 及其令牌相关条目,调整 auth.authenticator 描述为 StandardAuthenticator 或自定义实现,并新增远程认证与监控相关配置项(auth.remote_url、auth.token_expire、auth.token_secret、exception.allow_trace、memory_monitor.threshold、memory_monitor.period)。 Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 分钟 需要额外关注的文件/点:
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
Summary of ChangesHello @ChoHee15, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! 此拉取请求旨在通过删除所有与 Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
这个 PR 旨在从文档中移除已过时的 ConfigAuthenticator。相关的更改正确地从中文和英文版本的 config-guide.md 和 config-option.md 中删除了对 ConfigAuthenticator 的引用。这些更改是好的。我提出了两个小建议以提高文档的一致性。
Add description. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Add description. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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)
content/en/docs/config/config-option.md (1)
1-5: 缺少前置元数据中的 description 字段。根据编码指南,所有文档文件应在前置元数据中包含 title、weight 和 description。当前前置元数据缺少 description 字段。建议添加一个简洁的描述。
示例修改:
--- title: "HugeGraph Config Options" linkTitle: "Config Options" weight: 2 +description: "Configuration options for HugeGraph including Gremlin Server, REST Server, and various backends" ---
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/config/config-option.md(1 hunks)content/en/docs/config/config-option.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- content/cn/docs/config/config-option.md
🧰 Additional context used
📓 Path-based instructions (1)
content/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Include front matter (title, weight, description) in all documentation files
Files:
content/en/docs/config/config-option.md
🔇 Additional comments (2)
content/en/docs/config/config-option.md (2)
44-44: 认证器配置描述已正确更新。第 44 行的
auth.authenticator描述已更新,现在明确指出支持 StandardAuthenticator 或自定义实现,这与先前的审查建议一致,也符合移除过时 ConfigAuthenticator 引用的 PR 目标。
49-54: 新增配置项文档完整且恰当。添加的六个新配置项(auth.remote_url、auth.token_expire、auth.token_secret、exception.allow_trace、memory_monitor.threshold、memory_monitor.period)的文档清晰完整,每项都有默认值和准确的描述。这些条目的添加补充了之前缺失的配置选项文档。
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.
Pull request overview
This PR removes documentation for the deprecated ConfigAuthenticator class and its associated configuration options from the Apache HugeGraph documentation.
Key Changes
- Removed references to
org.apache.hugegraph.auth.ConfigAuthenticatorfrom authenticator configuration descriptions - Removed deprecated configuration options:
auth.admin_tokenandauth.user_tokens - Updated documentation to recommend
StandardAuthenticatoror custom implementations
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| content/en/docs/config/config-option.md | Removed ConfigAuthenticator references and related token configuration options from the English configuration options table |
| content/en/docs/config/config-guide.md | Removed ConfigAuthenticator mode section and updated authentication configuration comments in English guide |
| content/cn/docs/config/config-option.md | Removed ConfigAuthenticator references and related token configuration options from the Chinese configuration options table |
| content/cn/docs/config/config-guide.md | Removed ConfigAuthenticator mode section and updated authentication configuration comments in Chinese guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Purpose of the PR
ConfigAuthenticator 当前已废弃,该 PR 将文档中相关内容删除。
Summary by CodeRabbit
文档
✏️ Tip: You can customize this high-level summary in your review settings.