Re: GSoD approved technical writer - community bonding phase

[Moshe Kaplan <mosheekaplan () gmail com>]

1. The Wireshark manuals are written with docbook. The text is in the
wsug_src directory here:
https://gitlab.com/wireshark/wireshark/-/tree/master/docbook . Information
on submitting patches is available here:
https://gitlab.com/wireshark/wireshark/-/wikis/Development/SubmittingPatches
2. The missing documentation has the text: "Not yet written. If you would
like to fix this, see
https://wiki.wireshark.org/Development/SubmittingPatches"; in the user guide
 (https://www.wireshark.org/docs/wsug_html/). This is written in the
docbook as {missing}. For an example, see
https://gitlab.com/wireshark/wireshark/-/blob/master/docbook/wsug_src/WSUG_chapter_telephony.adoc#L38

I can't speak to the rest of the issues. Thank you for your efforts to
improve Wireshark's documentation.

Moshe

On Mon, Aug 17, 2020 at 8:36 AM Alex Nik <rage.iz.me () gmail com> wrote:

> Hello, everyone.
> My name is Alex and I was approved for the GSoD for this year. I will be
> working on documenting the 35 menu items, which are not yet described in
> the docs.
> Before I start (14th of September), I would like to get to know all the
> workload processes regarding writing the docs.
> 1. What format and tools are used?
> 2. Where to find those specific 35 undocumented menu items, which were
> mentioned in the project ideas?
> 3. What is the preferred way of the communication? (I prefer mail,
> Telegram)
> 4. What do you expect from the tech.writer? (Except for the end result of
> course)
> 5. Is there anything else I need to know before I start? Some specific of
> the project?
>
> Thanks!
> Looking forward to work with you.
>
> Alex
>
> ___________________________________________________________________________
> Sent via:    Wireshark-dev mailing list <wireshark-dev () wireshark org>
> Archives:    https://www.wireshark.org/lists/wireshark-dev
> Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev
>              mailto:wireshark-dev-request () wireshark org
> ?subject=unsubscribe
___________________________________________________________________________
Sent via:    Wireshark-dev mailing list <wireshark-dev () wireshark org>
Archives:    https://www.wireshark.org/lists/wireshark-dev
Unsubscribe: https://www.wireshark.org/mailman/options/wireshark-dev
             mailto:wireshark-dev-request () wireshark org?subject=unsubscribe