Skip to content

[r2cn] Web UI 重构:实现文档同步服务并可以和Issue 和MR 进行关联 #1184

Description

@benjamin-747

[任务] 实现文档同步服务并可以和Issue 和MR 进行关联

[任务分值] 30 分

[背景描述]

目前文档同步Nodejs 服务已经完成迁移部署,需要调查该部分代码并重构成Rust 服务,以支持之后Docs 与Mega 交互的一系列功能

[需求描述]
1.调查文档同步模块,确定要重构的Nodejs 服务,Campsite API 和数据库表结构;
2.实现Rust 文档同步模块,支持 Issue 关联跳转,MR 关联跳转和 Code 预览跳转;
3.和前端联调测试重构后的API。
4.输出相关的技术文档。

[代码标准]

  1. 所有 PR 提交必须签署 Signed-off-by 和 使用 GPG 签名,即提交代码时(使用 git commit 命令时)至少使用 -s -S 两个参数,参考 Contributing Guide
  2. 所有 PR 提交必须通过 GitHub Actions 自动化测试,提交 PR 后请关注 GitHub Actions 结果;
  3. 代码注释均需要使用英文;

[PR 提交地址] 提交到 mega 仓库的 main 分支 mono 目录;

[开发指导]

  1. 认领任务参考 r2cn 开源实习计划 - 任务认领与确认;

[导师及邮箱] 请申请此题目的同学使用邮件联系导师,或加入到 R2CN Discord 后在 #p-meta 频道和导师交流。

  1. Quanyi Ma genedna@gmail.com
  2. Tianxing Ye yetianxing2014@gmail.com

[备注]

  1. 认领实习任务的同学,必须完成测试任务和注册流程,请参考: r2cn 开源实习计划 - 测试任务r2cn 开源实习计划 - 学生注册与审核

Metadata

Metadata

Assignees

Type

Fields

No fields configured for Task.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions