How To Edit the Wireshark wiki
In order to become a wiki editor you must do the following:
-
Create a GitLab account if you don't already have one. You can create credentials on gitlab.com itself or register using your GitHub, Bitbucket, Google, or other credentials.
-
Request access to the Wiki Editors group,
…or… -
Send an email to wireshark-dev@wireshark.org with the following format (or something similar):
Subject: Wiki editor permission request
Hi,
I would like permission to edit the Wireshark wiki. My GitLab username is <your username>.- Go to https://gitlab.com/wireshark/editor-wiki/wikis/home and start making edits. If GitLab returns a 404 error, it's probably because you aren't logged in or you don't have edit permissions. The public wiki will be synchronized each time you save your changes.
Why do we have a separate project for editing the wiki? Because you need really powerful permissions to do so, and a separate project makes that safer and easier:
gitlab-org/gitlab#27294 (closed)
Contributing
In order to edit this wiki you should be familiar with Markdown, specifically GitLab Flavored Markdown.
Before contributing, please read the License page. If you don't agree with the license, then don't contribute.
Tables
Due to limitations with the conversion process, tables in wiki pages are now HTML. You can convert simple tables to GFM if desired.
Attachments
If you have an example capture file for a specific protocol, it is appreciated to put it into the SampleCaptures page and add a link to that file in the protocols page.
Screenshots
Please save screen captures as PNG or GIF. JPEG can introduce artifacts that make text fuzzy or otherwise difficult to read.
Protocol Documentation
Note: The instructions below have not been updated for the new Wiki. In particular, redirections do not work the same way, and all existing redirections are broken.
It's often the case that a protocol is known under different names or abbreviations, e.g. HTTP or HyperTextTransferProtocol, or ...
To prevent duplicated content, redirections are used, so one master page exists with maybe one or even more redirection pages pointing to it. When the wiki user clicks on this redirected term, he/she will see the master page, with a small comment at the top of the page about the redirection.
The master page should be named the way it's often used in the text on other pages (most of the time this will be the abbreviated protocol name). This results in not showing the redirection note most of the time. For example: to reduce typing, I would typically use HTTP in my texts, instead of the much longer HyperTextTransferProtocol, although this might be useful at some places.
When creating the master page, it's a good idea to use the Protocol Template page, which will give you a skeleton to fill in common protocol data.
The redirection page(s) can then simply be created using the Redirect Template page, while creating the page content of the redirection page.
So to create a new protocol page:
-
add the protocol name to the ProtocolReference page (by editing this page and using WikiName's) and save your changes
-
a "broken link" of your protocol will appear at the ProtocolReference page where you added it, click on it
-
you will be requested to add a new page, use the protocol or redirect template as described above
Imported from https://wiki.wireshark.org/HowToEdit on 2020-08-11 23:14:45 UTC