Skip to content
Wireshark Wiki 中文翻译整理专题首页原始页面

如何编辑 Wireshark Wiki

本页说明原 Wireshark Wiki 的编辑权限、贡献方式和页面命名约定。它主要面向想给 Wireshark 官方 Wiki 补充内容的人;如果你只是阅读 vants.org 的中文整理页,不需要执行这些步骤。

你想做什么该看哪一段注意事项
申请编辑权限编辑权限申请需要 GitLab 账户,并加入 Wireshark 的 Wiki Editors 组。
提交普通内容贡献、表格、附件、截图遵守许可,使用清晰的 Markdown 和合适的图片格式。
新增协议页面协议文档原页面说明基于旧 Wiki 习惯,迁移到 GitLab Wiki 后部分重定向规则已变化。
上传示例抓包附件更适合放到 SampleCaptures,并在协议页中引用。

编辑权限申请

要成为 Wireshark Wiki 编辑者,原页面给出两条路径:

  1. 如果还没有 GitLab 账户,先创建一个。可以直接在 gitlab.com 上注册,也可以使用 GitHub、Bitbucket、Google 等凭据登录。
  2. 请求访问 Wiki Editors 组,或者按类似格式发送邮件给 wireshark-dev@wireshark.org

邮件示例应拆成清晰的主题和正文:

text
Subject: Wiki editor permission request

Hi,

I would like permission to edit the Wireshark wiki. My GitLab username is <your username>.

获得权限后,可前往 Wireshark 的 GitLab Wiki 编辑页面开始编辑。如果 GitLab 返回 404,通常表示尚未登录或没有编辑权限。每次保存更改后,公共 Wiki 会同步。

原页面解释,单独设置编辑项目是因为 Wiki 编辑需要较高权限,把它隔离出来更安全、更容易管理。相关 GitLab 问题包括 gitlab-org/gitlab#25177gitlab-org/gitlab#27294

贡献前检查

项目要求
Markdown熟悉 GitLab Flavored Markdown。
许可阅读 License 页面;不同意许可就不要贡献。
事实协议字段、版本行为、工具命令应尽量引用官方文档或可复现样本。
页面结构新页面应让读者先知道“这是什么、什么时候用、注意什么”。

表格、附件和截图

表格

原页面说明,由于转换过程限制,Wiki 页面中的表格可能是 HTML。如果只是简单表格,可以转换为 GitLab Flavored Markdown 表格,便于维护。

附件

如果有某个协议的示例捕获文件,建议放入 SampleCaptures 页面,并在对应协议页面中添加链接。这样读者可以从协议说明跳转到可练习的数据包。

截图

截图建议保存为 PNG 或 GIF。JPEG 可能引入压缩伪影,使协议字段、菜单文字或包列表变得模糊,不利于排查和教学。

协议文档命名

原页面提醒,Wireshark Wiki 已在 2020 年 8 月 23 日从 MoinMoin 迁移到 GitLab 内置 Wiki(基于 Gollum)。迁移后,重定向的工作方式不同,旧重定向可能已经损坏。

协议通常会有多个名称或缩写,例如 HTTP、HyperTextTransferProtocol 等。旧 Wiki 的做法是:

步骤原页面建议当前注意事项
选择主页面名使用页面正文中最常见的协议名称,多数情况下是缩写。例如常用 HTTP,而不是更长的 HyperTextTransferProtocol。
避免重复用重定向把别名引到主页面。GitLab Wiki 迁移后重定向规则已变化,需要按当前平台验证。
新建协议页ProtocolReference 中添加协议名,再进入 broken link 创建页面。现在应先确认当前 Wiki 的创建流程。
页面模板使用 Protocol Template 或 Redirect Template。模板是否仍存在需以当前官方 Wiki 为准。

来源边界

Imported from https://wiki.wireshark.org/HowToEdit on 2020-08-11 23:14:45 UTC。此中文页重组了编辑流程,保留 GitLab Wiki 迁移和协议命名提醒;当前权限流程请以 Wireshark 官方 GitLab 页面为准。

原始页面图片

241111_request_access_anno
241111_request_access_anno

相关 Wireshark Wiki 页面

网络分析技术档案