SERVICE MANUAL

使用手册

门户、Gitea 仓库、Git 与服务器使用的统一说明。先看“三分钟找到你要的东西”,再按需查章节。

三分钟找到你要的东西

你想做什么去哪里
看战队最近发生了什么顶部「近况」
找本组项目、进度和负责人顶部「项目」
下载图纸、规范、模板顶部「开源资料」
提问、报进度、找队友顶部「论坛」
第一次来,按四周计划走顶部「新人引导」
写代码、交图纸、做版本管理Gitea:/git/
看服务器、仓库、备份说明顶部「服务器」(仅队长/管理员)

门户和 Gitea 使用同一个用户名,但密码分别管理。第一次登录后请立即改密码。

一、账号与登录

  1. 向管理员或组长申请账号,说明:姓名、组别(步兵/哨兵/平衡步兵/重装)、方向(机械/电控/算法)。
  2. 管理员审核通过后,用用户名登录门户;Gitea 由管理员开通到对应团队。
  3. 登录后进「个人中心」:改昵称、补方向、改密码。组别和方向由管理员维护,不能自己换组。
  4. 忘记密码:找管理员重置,重置后所有旧登录会失效。

权限一句话版

  • 队员:看全队公开内容 + 本组内容,参加本组论坛。
  • 组长:在本组内可以置顶/锁定帖子、管理本组内容。
  • 队长:看全队内容,管理全队论坛。
  • 管理员:账号、权限、全部内容和服务器。

二、门户怎么用

近况与会议

  • 「近况」分新闻、通知、会议纪要。会议纪要包含结论、分工和截止时间。
  • 每次例会后由记录人发一篇会议纪要;没到会的人必须在 24 小时内看完并在论坛回复“已阅”。

项目看板

  • 每个项目有组别、方向、负责人、进度和仓库地址。
  • 进度只写真实状态:未开始 / 进行中 / 联调中 / 已完成 / 暂停。
  • 项目页是“人和进度”,代码和图纸在 Gitea,两边不要混。

开源资料:先按大小选方式

文件大小怎么传存在哪里
≤ 20MB管理员后台 →「上传小文件」,直接选文件门户服务器,队员登录后可下载
> 20MB先在 Gitea 用 Git LFS 上传,再回后台「添加大文件链接」文件在 Gitea LFS,门户只存链接
  • 资料分机械、电控、算法、工具、文档、其他。
  • 下载前先看说明和版本;涉及他队开源协议的内容,标注来源和许可证。
  • 不要把几十兆的压缩包直接塞进论坛或门户小文件上传。
  • 队员没有后台权限时,把大文件推到本组仓库 LFS,再让管理员在门户补链接。

论坛

  • 发帖先选版块:公告、技术交流、新人报到、各组版块。
  • 标题写清楚“做什么 + 卡在哪”,例如「步兵底盘 CAN 断连,疑似供电,求排查思路」。
  • 报进度用固定格式:本周完成 / 遇到问题 / 下周计划 / 需要谁配合。
  • 技术帖尽量附:现象、复现步骤、日志/截图、已尝试方案。

三、Gitea 仓库怎么用

地址:https://zunshirm.de5.net/git/。登录后先确认右上角头像是自己,语言为中文。

第一次配置 Git

git config --global user.name "你的名字"
git config --global user.email "你的邮箱"
git config --global init.defaultBranch main

克隆仓库

HTTPS(推荐新队员,使用 Gitea 账号密码):

git clone https://zunshirm.de5.net/git/infantry/mechanical.git

SSH(仅内网/VPN):先在 Gitea「设置 → SSH 密钥」登记公钥;服务器地址与端口由组长单独告知,不写在公开页面。

日常流程

git checkout main
git pull
git checkout -b feat/底盘-电机温度采集
# 修改文件
git add .
git commit -m "feat(底盘): 增加电机温度采集"
git push -u origin feat/底盘-电机温度采集

然后在 Gitea 发起 Pull Request,至少一名同组队员 Review,合并到 dev。main 只放可参赛/可演示版本,禁止直接 push。

大文件怎么传(Git LFS)

先确认本机装了 Git LFS(git lfs version;没有就装 Git LFS),在仓库根目录执行:

git lfs install
git lfs track "*.step" "*.stp" "*.stl" "*.sldprt" "*.sldasm" "*.mp4" "*.zip" "*.7z" "*.pt" "*.onnx"
git add .gitattributes
git add 你的大文件
git commit -m "data: 添加底盘总装 STEP"
git push
  • git lfs track 会把规则写进 .gitattributes,这个文件必须一起提交。
  • 上传后用 git lfs ls-files 确认文件由 LFS 管理。
  • 单文件建议不超过 1GB;但公网 Cloudflare 免费版单次上传约 100MB,更大的文件在内网/VPN 用 SSH 或内网 HTTP 推送,或先拆分。
  • 已经误把大文件提交进历史?不要强推;找管理员用 git lfs migrate 处理。

仓库地图

组织仓库放什么
infantry / sentry / balance / heavymechanical三维模型、工程图、BOM、装配说明
同上electronics原理图、PCB、固件、接线与测试记录
同上algorithm视觉/控制/决策代码、模型、标定数据
同上projects本组项目汇总、周报、联调记录
zunshiportal门户源码与部署文件
zunshidocs制度、模板、培训资料
zunshiopen-source可对外开源的内容

提交前检查

  • 不提交密码、密钥、token、个人隐私;超过 20MB 的文件不要直接 git add,走 LFS。
  • 代码能编译/能跑;图纸有版本号和变更说明。
  • README 写清楚“怎么用、依赖什么、验证过什么”。
  • 大文件用 Git LFS:git lfs track "*.step",把 .gitattributes 一起提交;详见上一节。

Gitea 界面速查

  • 组织:左侧头像 → 组织 → 选 infantry 等,能看到本组仓库。
  • Issue:报问题、领任务;标题写清楚,指派给自己或负责人。
  • Pull Request:从 feat/* 合到 dev;描述里写改了什么、怎么测。
  • Wiki/README:仓库首页的 README 就是该仓库的说明书,先读再动手。
  • 通知:右上角铃铛;被 @ 或 Review 会提醒。

四、服务器使用(仅队长/管理员)

服务器承载门户、Gitea 与备份。普通队员不需要登录服务器;需要跑训练/仿真时,向组长申请临时账号或使用指定机器。

  • 服务器配置、数据盘、备份、重启与故障处理只由队长/管理员操作,具体见顶部「服务器」页(普通队员看不到入口)。
  • 不要在生产目录直接改代码;门户和 Gitea 都从仓库/部署目录运行。
  • 遇到服务异常:先确认门户和 Gitea 是否可访问,再找管理员;不要自行重启整机。
  • 公开页面不展示服务器地址、端口、路径和备份位置;需要时由管理员单独提供。

五、组长/管理员额外操作

  • 新成员:门户注册 → 管理员审核 → 分配组别/方向 → 加入 Gitea 对应团队。
  • 内容:后台可发新闻/通知/会议纪要,设置可见范围(公开/登录/本组/仅管理员)。
  • 论坛:置顶、锁定、删除;公告版块仅队长/管理员可发。
  • 仓库:组长管理本组 maintainers 团队;新增仓库先找管理员确认命名。
  • 每学期检查一次账号:离队成员及时停用,避免权限残留。

六、常见问题

Q:门户能登录,Gitea 登不上?
A:两个系统密码独立。先在 Gitea 用同一用户名尝试;仍不行找管理员重置,不要重复试错触发限流。

Q:看不到本组项目/资料?
A:确认管理员已把你的组别设对;组内容只对同组和队长/管理员可见。

Q:git push 提示权限不足?
A:确认你在对应组织/团队里;HTTPS 用 Gitea 用户名密码,SSH 用登记的密钥。仍不行把仓库名和报错发给组长。

Q:文件超过 20MB 怎么办?
A:不要直接 git add。按「大文件怎么传」用 Git LFS;门户资料区只接收 ≤20MB 的小文件,大文件在门户里只放 LFS 链接。

Q:门户上传提示文件太大?
A:门户小文件上限是 20MB。超过就切到「大文件链接」:先在 Gitea LFS 上传,再把文件页链接填进来。

Q:网站打不开?
A:先试内网地址;外网走 https://zunshirm.de5.net。两者都不行再找管理员,并说明时间和网络环境。

七、一页速查

门户        https://zunshirm.de5.net
Gitea       https://zunshirm.de5.net/git/
论坛        门户 → 论坛 → 选版块 → 发帖
新人任务    门户 → 新人引导(四周路线)
仓库规范    Gitea 仓库首页 README + 门户 → 开源资料
上传方式    ≤20MB 门户「上传小文件」;>20MB Gitea LFS + 门户链接
服务器      [仅队长/管理员] 门户 → 服务器
备份        [管理员维护,公开页不展示路径]

记住三件事:进度写进论坛,代码进仓库,会议结论有分工和截止时间。