-
Notifications
You must be signed in to change notification settings - Fork 120
docs: add Rust modernization roadmap #463
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
Draft
FenjuFu
wants to merge
1
commit into
apache:master
Choose a base branch
from
FenjuFu:agent/rust-modernization-roadmap
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−0
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
49 changes: 49 additions & 0 deletions
49
content/cn/docs/contribution-guidelines/rust-modernization.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: "Rust 渐进式现代化路线图" | ||
| linkTitle: "Rust 现代化" | ||
| weight: 7 | ||
| description: "HugeGraph 各组件渐进式 Rust 实验的状态与贡献入口。" | ||
| --- | ||
|
|
||
| 本页是 HugeGraph 生态渐进式 Rust 现代化工作的文档入口。它用于汇总仍在推进的提案,并不代表项目承诺重写现有组件,也不代表相关功能已经发布。 | ||
|
|
||
| ## 路线图 | ||
|
|
||
| | 领域 | 仓库 | 跟踪 Issue | 当前成熟度 | 负责人 | | ||
| | --- | --- | --- | --- | --- | | ||
| | 工具链 | `apache/hugegraph-toolchain` | [#748](https://github.com/apache/hugegraph-toolchain/issues/748) | 提案跟踪 | 待在 Issue 中确认 | | ||
| | Server、HStore 与 PD | `apache/hugegraph` | [#3110](https://github.com/apache/hugegraph/issues/3110) | 提案跟踪 | 待在 Issue 中确认 | | ||
| | 图计算 | `apache/hugegraph-computer` | [#355](https://github.com/apache/hugegraph-computer/issues/355) | 提案跟踪 | 待在 Issue 中确认 | | ||
| | 文档中心 | `apache/hugegraph-doc` | [#462](https://github.com/apache/hugegraph-doc/issues/462) | 提案跟踪 | 待在 Issue 中确认 | | ||
|
|
||
| 上述 Issue 是范围和状态的事实来源。在代码、测试和文档被接受之前,不应把提案描述为已经实现。 | ||
|
|
||
| ## 统一成熟度术语 | ||
|
|
||
| - **提案跟踪(Proposal tracking)**:已有 Issue,但尚无被接受的实现。 | ||
| - **实验(Experiment)**:已有可评估的概念验证;API、格式和行为可能变化,不提供兼容性保证。 | ||
| - **预览(Preview)**:已有安装和验证文档,可供选择性评估,但尚不推荐作为生产环境默认方案。 | ||
| - **生产就绪(Production-ready)**:维护者已经明确支持范围、兼容性、升级与回滚、运行限制及发布版本。 | ||
|
|
||
| 每个 Rust 相关页面都应注明成熟度、负责仓库或 Issue、支持平台、已知限制,以及包含该行为的发布版本。规划中的行为必须明确标记为**提案**。 | ||
|
|
||
| ## 交付门槛 | ||
|
|
||
| 文档应随实现同步演进: | ||
|
|
||
| 1. **RFC 或提案**:记录目标、非目标、负责人、兼容性风险和验收标准。 | ||
| 2. **概念验证**:提供可复现的构建与测试步骤,并列出已知限制。 | ||
| 3. **预览**:补充兼容性矩阵、迁移与回滚、基准测试和故障排查。 | ||
| 4. **生产就绪**:说明支持的版本与平台、升级保证、运行指南和对应发布版本。 | ||
|
|
||
| ## 如何参与 | ||
|
|
||
| 请选择一个关联的跟踪 Issue,并先确认计划工作没有被其他贡献者认领。适合作为第一步的贡献包括: | ||
|
|
||
| - 根据已接受的工作同步路线图表格; | ||
| - 在负责仓库中提出 Rust 工具链与 workspace 约定; | ||
| - 添加兼容性、平台或基准报告模板; | ||
| - 用可复现命令记录已接受的概念验证; | ||
| - 保持中英文内容一致。 | ||
|
|
||
| 基准测试结论必须包含源码版本、硬件、数据集、配置、命令和可重复结果,否则不应发布。 |
49 changes: 49 additions & 0 deletions
49
content/en/docs/contribution-guidelines/rust-modernization.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: "Rust Modernization Roadmap" | ||
| linkTitle: "Rust Modernization" | ||
| weight: 7 | ||
| description: "Status and contribution entry points for incremental Rust experiments across HugeGraph." | ||
| --- | ||
|
|
||
| This page is the documentation entry point for proposed, incremental Rust modernization work across the HugeGraph ecosystem. It is a map of active proposals, not a commitment to rewrite existing components or evidence that a feature has shipped. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| | Area | Repository | Tracking issue | Current maturity | Owner | | ||
| | --- | --- | --- | --- | --- | | ||
| | Toolchain | `apache/hugegraph-toolchain` | [#748](https://github.com/apache/hugegraph-toolchain/issues/748) | Proposal tracking | To be assigned in the issue | | ||
| | Server, HStore, and PD | `apache/hugegraph` | [#3110](https://github.com/apache/hugegraph/issues/3110) | Proposal tracking | To be assigned in the issue | | ||
| | Graph computing | `apache/hugegraph-computer` | [#355](https://github.com/apache/hugegraph-computer/issues/355) | Proposal tracking | To be assigned in the issue | | ||
| | Documentation | `apache/hugegraph-doc` | [#462](https://github.com/apache/hugegraph-doc/issues/462) | Proposal tracking | To be assigned in the issue | | ||
|
|
||
| The linked issues are the source of truth for scope and status. A proposal must not be described as implemented until its code, tests, and documentation have been accepted. | ||
|
|
||
| ## Shared maturity terms | ||
|
|
||
| - **Proposal tracking**: an issue exists, but no implementation has been accepted. | ||
| - **Experiment**: a proof of concept is available for evaluation. Its APIs, formats, and behavior may change without compatibility guarantees. | ||
| - **Preview**: the component has documented installation and validation paths and is suitable for opt-in evaluation, but is not yet recommended as a production default. | ||
| - **Production-ready**: maintainers have documented support scope, compatibility, upgrades, rollback, operational limits, and release availability. | ||
|
|
||
| Every Rust-related page should state its maturity, owning repository or issue, supported platforms, known limitations, and the release containing the documented behavior. Planned behavior should be labeled **proposed**. | ||
|
|
||
| ## Delivery gates | ||
|
|
||
| Documentation evolves with implementation: | ||
|
|
||
| 1. **RFC or proposal**: record goals, non-goals, ownership, compatibility risks, and acceptance criteria. | ||
| 2. **Proof of concept**: document a reproducible build and test path plus known limitations. | ||
| 3. **Preview**: add compatibility matrices, migration and rollback procedures, benchmarks, and troubleshooting. | ||
| 4. **Production-ready**: document supported versions and platforms, upgrade guarantees, operational guidance, and release references. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| Choose one of the linked tracking issues and confirm that your intended work is not already claimed. Useful first contributions include: | ||
|
|
||
| - keeping the roadmap table synchronized with accepted work; | ||
| - proposing a Rust toolchain and workspace convention in the owning repository; | ||
| - adding compatibility, platform, or benchmark-report templates; | ||
| - documenting an accepted proof of concept with reproducible commands; | ||
| - maintaining equivalent English and Chinese content. | ||
|
|
||
| Do not publish benchmark claims without the source revision, hardware, dataset, configuration, commands, and repeated results needed to reproduce them. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.