mentored-projects

#88 Outreachy: Improve NetworkManager documentation
Closed by ffmancera. Opened by ffmancera.

Closed
Reopen Issue
  • One-line name:
    Improve NetworkManager documentation
  • Longer description of the project
    NetworkManager is a dynamic network control and configuration system that attempts to keep network devices and connections up and active when they are available.
    There is NetworkManager user documentation on the wiki.gnome.org and in the manual pages that are written in docbook. The idea of the project is to review and improve this documentation adding the missing documentation and refactoring the existing one.
  • License of the project
    LGPL-2.1+ and GPL-2.0+
  • Community size
    It is widely use in a lot of distributions (Fedora, RHEL, CentOS, Ubuntu, Archlinux, Debian..)
  • How will this project benefit Fedora?
    Fedora is using NetworkManager by default so the Fedora users will see their NM documentation improved.
  • Sample plan of work for the 12 week internship. What are milestones the
    intern should be hitting?
    -W1: Understand how NetworkManager works at a high level
    -W2: Study the current state of NetworkManager documentation
    -W3: Identify points where information is missing or not up to date
    -W4-5: Produce a new document explaining how NetworkManager works and how to interact with it
    -W6-7: Update and fill in gaps in the existing documentation
    -W8: Review of the work done so far
    -W9-11: Populate the NetworkManager website (Gitlab Pages) with both the existing and newly-produced documentation
    -W12: NetworkManager website review
  • Benefits to intern (What will the intern get out of this internship)
    Learn how to write technical documentation.
    Learn free software workflow.
    Learn how linux networking is managed.
    Confidence working in a professional environment.
    A network of industry contacts.
    Exposure to new skills.
    Increased employability.
    Exposure to world of open source.
  • Project website
    https://wiki.gnome.org/Projects/NetworkManager/
  • Project repo
    https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/tree/master
  • Where can an applicant find application tasks?
    Issues on https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues
  • IRC
    freenode #nm
  • Skills required including what level and if they are optional
    Basic linux skill (required)
    Basic networking knowledge (optional)
  • Outreachy applicants are required to make a contribution as part of the
    application. What is the process for making a contribution?
    https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/blob/master/CONTRIBUTING
  • How long have you been contributing to the community:
    1 Year (Antonio Cardace)
  • What is your current role
    Software Engineer, core developer (Antonio Cardace)
  • Have you mentored for a three-month internship program before
    No.
  • Have you read the mentor page and understand the process of being a mentor
    Yes.
  • Are you available for 5 hours a week during the internship period
    Yes
  • Are you available for 5-10 hours a week during the application period
    Yes
  • Are you aware you need to sign a mentor contract
    Yes

I will provide more information about the development plan tomorrow. Thanks!

Done, thanks!

Metadata Update from @siddharthvipul1:
- Issue tagged with: Outreachy
siddharthvipul1 commented

https://pagure.io/mentored-projects/issue/87#comment-688516

Closed because of #90

Metadata Update from @ffmancera:
- Issue status updated to: Closed (was: Open)
Metadata
None

program - Outreachy

None
None
None
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.