Merge pull request #38 from RITlug/refactor/sentence-per-line

Refactor Runbook to one sentence per line in every file

docs/administration/campusgroups-management.rst

@@ -3,9 +3,8 @@ Managing CampusGroups
 #####################
 
 `CampusGroups`_ is the club management platform provided by RIT Clubs office.
-For RIT Clubs office record-keeping, CampusGroups is used. This article
-documents routine actions or maintenance work to manage the RITlug CampusGroups
-profile.
+For RIT Clubs office record-keeping, CampusGroups is used.
+This article documents routine actions or maintenance work to manage the RITlug CampusGroups profile.
 
 - `RITlug CampusGroups page`_
 
@@ -32,10 +31,8 @@ Responsibilities
 Update officers
 ***************
 
-CampusGroups has an Officers page used by RIT Clubs office to recognize club
-leadership and assign RIT web service permissions (see
-:doc:`../events/event-management-system`) as needed. The page is under the
-*Dashboard* menu.
+CampusGroups has an Officers page used by RIT Clubs office to recognize club leadership and assign RIT web service permissions (see :doc:`../events/event-management-system`) as needed.
+The page is under the *Dashboard* menu.
 
 .. figure:: /_static/img/campusgroups-management-officers.png
    :alt: Update eboard officers from the Officers page
@@ -49,16 +46,14 @@ RITlug recognizes these positions on our executive board:
 - Treasurer (*required*)
 - Secretary
 - Officer (*role varies*)
-- Faculty advisor
+- Faculty advisor (*required*)
 
 Permissioning
 =============
 
-All eboard officers should be listed as *Active Officer* and *Visible on
-Website*.
+All eboard officers should be listed as *Active Officer* and *Visible on Website*.
 
-The president, vice president, and faculty advisor(s) should be listed as *Main
-contact*.
+The president, vice president, and faculty advisor(s) should be listed as *Main contact*.
 
 .. figure:: /_static/img/campusgroups-management-officers-permissions.png
    :alt: An eboard officer and advisor permissions compared side by side
@@ -68,8 +63,8 @@ contact*.
 Add eboard member
 =================
 
-Begin from the *Officers* page for RITlug in CampusGroups. A member-elect must
-join the RITlug organization in CampusGroups first to appear in the interface.
+Begin from the *Officers* page for RITlug in CampusGroups.
+A member-elect must join the RITlug organization in CampusGroups first to appear in the interface.
 
 #. Click *Add Officer* in upper-right corner
 #. Search by name or RIT email address for the member-elect
@@ -82,18 +77,16 @@ Remove eboard member
 
 .. note::
 
-   This has never been done before in CampusGroups! When done next, it should be
-   documented here.
+   This has never been done before in CampusGroups! When done next, it should be documented here.
 
 
 ****************
 Maintain records
 ****************
 
-RITlug does not use many features of CampusGroups because we already have some
-tools or systems in place. However, RIT Clubs office uses CampusGroups as a
-primary electronic data source for RIT student organizations. Therefore,
-information should be current.
+RITlug does not use many features of CampusGroups because we already have some tools or systems in place.
+However, RIT Clubs office uses CampusGroups as a primary electronic data source for RIT student organizations.
+Therefore, information should be current.
 
 Address
 =======
@@ -112,17 +105,17 @@ Address
 Other records
 =============
 
-Other records are either not regularly updated or not used. Future eboards may
-choose to utilize CampusGroups in more detail.
+Other records are either not regularly updated or not used.
+Future eboards may choose to utilize CampusGroups in more detail.
 
 
 **************
 Hold elections
 **************
 
-Eboard elections must be held via CampusGroups. This is to combat corruption and
-embezzlement of RIT Clubs funding. CampusGroups standardizes student
-organization elections for consistency and fairness.
+Eboard elections must be held via CampusGroups.
+This is to combat corruption and embezzlement of RIT Clubs funding.
+CampusGroups standardizes student organization elections for consistency and fairness.
 
 Elections are a special type of survey in the *Surveys* menu.
 

docs/administration/club-binder-contents.rst

@@ -2,8 +2,7 @@
 Club binder contents
 ####################
 
-This document is a table of contents for the RITlug club binder in the RIT
-Clubs office.
+This document is a table of contents for the RITlug club binder in the RIT Clubs office.
 
 
 ****************

docs/administration/club-binder.rst

@@ -2,23 +2,19 @@
 Club binder
 ###########
 
-The RITlug club binder is a physical source of information about the club. It
-contains hard copies of the club documentation from GitHub, club accounts, and
-documentation from the RIT club office.
+The RITlug club binder is a physical source of information about the club.
+It contains hard copies of the club documentation from GitHub, club accounts, and documentation from the RIT club office.
 
-The RITlug club binder is passed from president to president during executive
-board transitions (see :doc:`eboard-onboarding-offboarding`). Even though most
-of RITlug's documentation is available or maintained as electronic records, the
-club binder should be **updated annually**.
+The RITlug club binder is passed from president to president during executive board transitions (see :doc:`eboard-onboarding-offboarding`).
+Even though most of RITlug's documentation is available or maintained as electronic records, the club binder should be **updated annually**.
 
 
 *****************
 Table of contents
 *****************
 
-See :doc:`club-binder-contents` to see the table of contents in the club
-binder. This is maintained as a separate document to be printed and inserted
-into the physical binder.
+See :doc:`club-binder-contents` to see the table of contents in the club binder.
+This is maintained as a separate document to be printed and inserted into the physical binder.
 
 
 *******************
@@ -41,20 +37,18 @@ Club governance
 ===============
 
 Part of the club binder includes the club governance, like the constitution.
-The club governance documents are hosted in a different GitHub repo,
-`RITlug/governance`_. Follow `these steps`_ to generate updated versions of
-the governance documentation.
+The club governance documents are hosted in a different GitHub repo, `RITlug/governance`_.
+Follow `these steps`_ to generate updated versions of the governance documentation.
 
-- Clone `RITlug/governance`_, install dependencies, compile documents into PDFs
-  from LATeX
+- Clone `RITlug/governance`_, install dependencies, compile documents into PDFs from LATeX
 
 - Print generated PDFs (print updated pages to save paper)
 
 Club accounts
 =============
 
-- Request copy of RITlug budget report from Clubs office. Print sheets from
-  document as needed.
+- Request copy of RITlug budget report from Clubs office.
+  Print sheets from document as needed.
 
 
 .. _`rendered version`: https://media.readthedocs.org/pdf/ritlug-runbook/latest/ritlug-runbook.pdf

docs/administration/eboard-onboarding-offboarding.rst

@@ -1,26 +1,24 @@
 Eboard transitioning
 ====================
 
-This document explains how the exiting RITlug executive board (a.k.a. Eboard)
-transitions to a new, incoming executive board.
+This document explains how the exiting RITlug executive board (a.k.a. eboard) transitions to a new, incoming executive board.
 
 
-On-boarding incoming Eboard
+On-boarding incoming eboard
 ---------------------------
 
 Elections
 ^^^^^^^^^
 
-Elections are held towards the end of the spring semester. Running an annual
-election is required by the club office and should never be skipped. Follow
-these steps to execute an election.
+Elections are held towards the end of the spring semester.
+Running an annual election is required by the club office and should never be skipped.
+Follow these steps to execute an election.
 
 *Note*: Elections can also be held in the fall if a seat is left vacant.
 
 - **Week 10**: Open call for nominations
 
-    - Open call for nominations, for club members to nominate others in the
-      community to nominate others for Eboard positions
+    - Open call for nominations, for club members to nominate others in the community to nominate others for eboard positions
 
     - Verify / confirm nominations with nominees
 
@@ -30,92 +28,72 @@ these steps to execute an election.
 
     - At start of Week 12, open election with all nominated candidates
 
-    - Accept votes in a Google Drive form that requires logins to vote (to
-      prevent voter fraud); remind club members that voting is anonymous
+    - Accept votes in a Google Drive form that requires logins to vote (to prevent voter fraud); remind club members that voting is anonymous
 
     - After accepting votes, close form, tally responses
 
-    - At Week 12 meeting, announce results and display anonymized results to
-      club members in room
+    - At Week 12 meeting, announce results and display anonymized results to club members in room
 
-    - After announcing winners, current Eboard should **permanently delete**
-      the data associated with voting form (to protect voter identity)
+    - After announcing winners, current eboard should **permanently delete** the data associated with voting form (to protect voter identity)
 
-Don't forget to congratulate all nominees for their participation in the
-election.
+Don't forget to congratulate all nominees for their participation in the election.
 
 
 CampusGroups roles
 ^^^^^^^^^^^^^^^^^^
 
-All RIT clubs are required to use CampusGroups and maintain records there for
-the clubs office. After holding an election, update the incoming Eboard members
-inside of CampusGroups.
+All RIT clubs are required to use CampusGroups and maintain records there for the clubs office.
+After holding an election, update the incoming eboard members inside of CampusGroups.
 
-Detailed documentation on CampusGroups can be found on the
-:doc:`campusgroups-management` page.
+Detailed documentation on CampusGroups can be found on the :doc:`campusgroups-management` page.
 
 
 Introduce faculty adviser
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Outgoing Eboard members should help incoming members maintain a relationship
-with the faculty adviser. Arrange a meeting time for the outgoing and incoming
-Eboard members to meet with the faculty adviser.
+Outgoing eboard members should help incoming members maintain a relationship with the faculty adviser.
+Arrange a meeting time for the outgoing and incoming eboard members to meet with the faculty adviser.
 
 See more information on the :doc:`faculty-adviser` page.
 
 
 Other on-boarding tasks
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-- Grant operator privileges to incoming Eboard members in the IRC channel (see
-  how in :doc:`../infrastructure/irc-channel`).
+- Grant operator privileges to incoming eboard members in the IRC channel (see how in :doc:`../infrastructure/irc-channel`).
 
-- Add incoming Eboard members as admins to `Facebook group`_
+- Add incoming eboard members as admins to `Facebook group`_
 
-- Transfer ownership of RIT computer account for RITlug (i.e. ritlug at rit dot
-  edu)
+- Transfer ownership of RIT computer account for RITlug (i.e. ritlug at rit dot edu)
 
-- Add incoming Eboard to new Eboard team in GitHub organization, archive old
-  Eboard team, grant ownership privileges to president / vice president (see
-  :doc:`github-org` for detailed information)
+- Add incoming eboard to new eboard team in GitHub organization, archive old eboard team, grant ownership privileges to president / vice president (see :doc:`github-org` for detailed information)
 
-- Share this Runbook with incoming Eboard members, encourage questions and
-  feedback on improving the Runbook
+- Share this Runbook with incoming eboard members, encourage questions and feedback on improving the Runbook
 
 - *If new president*:
 
     - Pass off club binder at club office to new president
 
     - Transfer ownership of Google Drive folder to new president
 
-- Add incoming Eboard members as collaborators with write access to the RITlug
-  Google Drive folder
+- Add incoming eboard members as collaborators with write access to the RITlug Google Drive folder
 
-- Incoming Eboard members should take financial certification test from RIT
-  clubs office (all Eboard members **must be certified** to use club funds)
+- Incoming eboard members should take financial certification test from RIT clubs office (all eboard members **must be certified** to use club funds)
 
 .. _`Facebook group`: https://www.facebook.com/groups/RITLUG/
 
 
-Off-boarding outgoing Eboard
+Off-boarding outgoing eboard
 ----------------------------
 
-These tasks are done at the discretion of the incoming Eboard members. All
-steps are highly recommended, but are not required. Use best judgment for
-whether access should be revoked (especially if outgoing members remain active
-members of RITlug).
+These tasks are done at the discretion of the incoming eboard members.
+All steps are highly recommended, but are not required.
+Use best judgment for whether access should be revoked (especially if outgoing members remain active members of RITlug).
 
 1. Revoke account privileges from any RITlug-owned machines or servers
-2. Remove outgoing members from current "Eboard" team in GitHub, remove
-   ownership rights if they have it
+2. Remove outgoing members from current "Eboard" team in GitHub, remove ownership rights if they have it
 3. Revoke admin privileges on Facebook group
-4. Remove channel operator privileges on IRC (optionally can grant voice
-   privileges)
-5. Remove permissions / roles in CampusGroups (see
-   :doc:`campusgroups-management` for more information)
+4. Remove channel operator privileges on IRC (optionally can grant voice privileges)
+5. Remove permissions / roles in CampusGroups (see :doc:`campusgroups-management` for more information)
 6. Revoke privileges in RITlug Google Drive folder
-7. Transfer account ownership of RIT computer account, update any info and
-   reset password (if necessary)
-
+7. Transfer account ownership of RIT computer account, update any info and reset password (if necessary)