Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

Conversation

@ChoHee15
Copy link
Collaborator

@ChoHee15 ChoHee15 commented Dec 2, 2025

Purpose of the PR

ConfigAuthenticator 当前已废弃,该 PR 将文档中相关内容删除。

Summary by CodeRabbit

文档

  • 更新了身份验证配置文档,移除对旧配置方式的提示,仅保留标准身份验证器与自定义实现说明
  • 移除已弃用的令牌相关配置选项(管理令牌与用户令牌)
  • 新增远程身份验证、令牌过期时间与令牌密钥等配置选项
  • 新增系统监控与异常处理相关配置(允许追踪、内存监控阈值与周期)

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions
Copy link

github-actions bot commented Dec 2, 2025

@codecov-ai-reviewer review

@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

Note

Other AI code review bot(s) detected

CodeRabbit 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

内聚体 / 文件(s) 变更摘要
中文配置文档
content/cn/docs/config/config-guide.md, content/cn/docs/config/config-option.md
删除 ConfigAuthenticator 相关注释与配置条目(auth.admin_token, auth.user_tokens),将 auth.authenticator 描述改为引用 StandardAuthenticator 或自定义实现;新增/调整认证相关说明以支持远程认证与令牌参数。
英文配置文档
content/en/docs/config/config-guide.md, content/en/docs/config/config-option.md
同步中文改动:移除 auth.admin_tokenauth.user_tokens,更新 auth.authenticator 描述;新增配置条目 auth.remote_url, auth.token_expire, auth.token_secret,以及 exception.allow_trace, memory_monitor.threshold, memory_monitor.period

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 分钟

需要额外关注的文件/点:

  • content/en/docs/config/config-option.mdcontent/cn/docs/config/config-option.md 中新增配置条目的描述是否完整且一致
  • 确认所有出现的 ConfigAuthenticator 相关注释/示例均已移除或替换
  • 校对中英文同步与术语一致性(例如 StandardAuthenticator、远程认证、token 字段名)

Poem

旧令牌随风去,兔足轻敲新页;
配置成行又成诗,远程认证悄然来。
我在草丛里跳舞,文档焕然一新。 🐰

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR标题清晰准确地反映了主要改动:移除已过时的ConfigAuthenticator相关文档。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link

Summary of Changes

Hello @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!

此拉取请求旨在通过删除所有与 ConfigAuthenticator 相关的提及和配置来清理文档,因为该组件已被废弃。这确保了文档能够准确反映系统的当前状态,并避免用户产生混淆。

Highlights

  • 文档清理: 从中文和英文的配置指南中移除了对已废弃的 ConfigAuthenticator 的所有引用和相关配置示例。
  • 配置选项更新: 更新了配置选项表格,删除了 ConfigAuthenticator 特有的 auth.admin_tokenauth.user_tokens 选项,并修改了 auth.authenticator 的描述以反映其弃用。
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a 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.mdconfig-option.md 中删除了对 ConfigAuthenticator 的引用。这些更改是好的。我提出了两个小建议以提高文档的一致性。

ChoHee15 and others added 2 commits December 2, 2025 19:09
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>
Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ed359e and 4b9f914.

📒 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)的文档清晰完整,每项都有默认值和准确的描述。这些条目的添加补充了之前缺失的配置选项文档。

Copy link

Copilot AI left a 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.ConfigAuthenticator from authenticator configuration descriptions
  • Removed deprecated configuration options: auth.admin_token and auth.user_tokens
  • Updated documentation to recommend StandardAuthenticator or 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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant