Re: Volunteers and ideas needed for Google Season of Docs

[Moshe Kaplan <me () moshekaplan com>]

6) Remediating the known documentation issues in Bugzilla:
https://bugs.wireshark.org/bugzilla/buglist.cgi?component=Documentation&list_id=55638&product=Wireshark&resolution=---

Moshe

On Fri, Apr 12, 2019 at 9:32 AM Moshe Kaplan <me () moshekaplan com> wrote:

> Some specific ideas from what I've noticed (mostly in the User Guide):
>
> 1) There are 35 menu items that aren't documented in the User Guide. These
> are indicated in the docs as " Not yet written. See
> https://wiki.wireshark.org/Development/SubmittingPatches";
> 2) The User Guide references the Wiki (I'm guilty of doing that myself). I
> think it would be beneficial to move any referenced information to the User
> Guide and Developer Guide so that a single release's guides has all of the
> information.
> 3) There appears to still be some ambiguity to what belongs in the Wiki vs
> the User Guide. One possible approach would be to move any
> Wireshark-specific guidance from the Wiki to the User Guide and then remove
> it from the Wiki. (note: this has overlap with #2)
> 4) Standard proofreading and reviewing for clarity and accuracy.
> 5) Update screenshots from GTK UI to QT UI . Document (in comments) which
> files were used to create the screenshots.
>
> Moshe
>
>
>
> On Wed, Apr 10, 2019 at 5:30 PM Gerald Combs <gerald () wireshark org> wrote:
>
> > Google recently announced its Season of Docs[1], a project similar to the
> > Summer of Code which is intended to help technical writers and open source
> > projects work together. I think it would be a great idea for Wireshark
> > participate, and in order to do so we need the following[2]:
> >
> > Two or more organization administrators.
> >
> > Two or more mentors for each project.
> >
> > A list of project ideas. Suggestions so far are:
> >
> > - User's Guide updates
> > - Developer's Guide updates
> > - Wiki updates
> > - Add quick starts / tutorials via Qt Help
> > - Man page updates
> >
> > I can be an administrator and a mentor, but in order to participate we
> > need at least one more person for each of those roles. If you would like to
> > volunteer, please contact me directly.
> >
> > [1] https://developers.google.com/season-of-docs/
> > [2] https://developers.google.com/season-of-docs/docs/admin-guide
> >
> > ___________________________________________________________________________
> > 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