From 21d7851a4cbd9bdcd8de16790a40e7e48720adf6 Mon Sep 17 00:00:00 2001 From: "Justin W. Flory" Date: Sat, 24 Mar 2018 12:51:27 -0400 Subject: [PATCH 1/2] Add introduction to index page --- docs/index.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 5bd3126..3f5d15f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to the RITlug Runbook! -============================== +RITlug Runbook +============== + +The Runbook is the primary resource to help executive board members of the `RIT Linux Users Group `_ manage and run the club. +Different aspects of running the club are detailed in the Runbook. +Different topics are sorted and organized below. + .. toctree:: :maxdepth: 2 From ef207cf6d07bf3ef3f69e59c277eb903dd9a4ff9 Mon Sep 17 00:00:00 2001 From: "Justin W. Flory" Date: Sat, 24 Mar 2018 13:23:39 -0400 Subject: [PATCH 2/2] Refactor Runbook to one sentence per line --- .../campusgroups-management.rst | 43 +++--- docs/administration/club-binder-contents.rst | 3 +- docs/administration/club-binder.rst | 28 ++-- .../eboard-onboarding-offboarding.rst | 82 ++++------- docs/administration/faculty-adviser.rst | 55 +++----- docs/administration/github-org.rst | 58 ++++---- docs/events/club-fairs.rst | 33 ++--- docs/events/event-management-system.rst | 17 +-- docs/events/meetings.rst | 129 +++++++----------- docs/infrastructure/hosted-server.rst | 22 +-- docs/infrastructure/irc-channel.rst | 67 +++------ docs/infrastructure/website.rst | 57 +++----- docs/roles/president.rst | 20 +-- docs/roles/project-coordinator.rst | 30 ++-- docs/roles/secretary.rst | 20 +-- docs/roles/treasurer.rst | 27 ++-- docs/roles/vice-president.rst | 25 ++-- docs/tasks/announcements.rst | 49 +++---- docs/tasks/semester-checklist.rst | 13 +- 19 files changed, 291 insertions(+), 487 deletions(-) diff --git a/docs/administration/campusgroups-management.rst b/docs/administration/campusgroups-management.rst index 711b0af..f20c490 100644 --- a/docs/administration/campusgroups-management.rst +++ b/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. diff --git a/docs/administration/club-binder-contents.rst b/docs/administration/club-binder-contents.rst index 9424341..0c31f9f 100644 --- a/docs/administration/club-binder-contents.rst +++ b/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. **************** diff --git a/docs/administration/club-binder.rst b/docs/administration/club-binder.rst index 84c32c7..eb11191 100644 --- a/docs/administration/club-binder.rst +++ b/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 diff --git a/docs/administration/eboard-onboarding-offboarding.rst b/docs/administration/eboard-onboarding-offboarding.rst index 88d35b6..f4acaa2 100644 --- a/docs/administration/eboard-onboarding-offboarding.rst +++ b/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,38 +28,31 @@ 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. @@ -69,20 +60,15 @@ 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*: @@ -90,32 +76,24 @@ Other on-boarding tasks - 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) diff --git a/docs/administration/faculty-adviser.rst b/docs/administration/faculty-adviser.rst index 6c1548f..d086340 100644 --- a/docs/administration/faculty-adviser.rst +++ b/docs/administration/faculty-adviser.rst @@ -1,28 +1,24 @@ Faculty Adviser =============== -All official RIT clubs must have a faculty adviser. The faculty adviser is a -more permanent position in the club and they are not subject to annual -elections. +All official RIT clubs must have a faculty adviser. +The faculty adviser is a more permanent position in the club and they are not subject to annual elections. -The faculty adviser may change at any time during the year. If this happens, a -new adviser should be found immediately (or else the club risks losing -recognition by student government). Once found, the former adviser should be -off-boarded and the new one on-boarded. +The faculty adviser may change at any time during the year. +If this happens, a new adviser should be found immediately (or else the club risks losing recognition by student government). +Once found, the former adviser should be off-boarded and the new one on-boarded. Adviser responsibilities ------------------------ -Faculty advisers can take a hands-on or hands-off role. In the past, RITlug's -adviser is usually hands-off, assuming the club is well-behaved and there is -regular communication with the adviser. If a new adviser is selected, they -should meet with the current Eboard and discuss expectations. +Faculty advisers can take a hands-on or hands-off role. +In the past, RITlug's adviser is usually hands-off, assuming the club is well-behaved and there is regular communication with the adviser. +If a new adviser is selected, they should meet with the current eboard and discuss expectations. -The adviser is a point of contact for the club and RIT clubs office. Thus, -there are a few forms that the adviser must sign annually (usually at the -beginning and end of the year). Periodically, the adviser may be needed to -resolve issues with the clubs office or with renewing club resources. +The adviser is a point of contact for the club and RIT clubs office. +Thus, there are a few forms that the adviser must sign annually (usually at the beginning and end of the year). +Periodically, the adviser may be needed to resolve issues with the clubs office or with renewing club resources. Adviser on-boarding @@ -32,35 +28,26 @@ Adviser on-boarding - Clubs office sends email invitation they should accept - - Ask if other steps should be followed to bring in a new adviser, in case - requirements by clubs office have changed [#]_ + - Ask if other steps should be followed to bring in a new adviser, in case requirements by clubs office have changed [#]_ -- Instruct new adviser to contact RIT clubs office (they will be sent paperwork - to formally accept role) +- Instruct new adviser to contact RIT clubs office (they will be sent paperwork to formally accept role) -- Follow Eboard on-boarding procedures for faculty adviser (see - :doc:`eboard-onboarding-offboarding`) +- Follow eboard on-boarding procedures for faculty adviser (see :doc:`eboard-onboarding-offboarding`) -- Organize formal meeting between current Eboard and new adviser to communicate - expectations and/or concerns - -.. [#] Always ask – RIT clubs office often does not clearly communicate when - requirements have changed +- Organize formal meeting between current eboard and new adviser to communicate expectations and/or concerns Adviser off-boarding -------------------- -*Note*: If off-boarding an adviser, ensure a new adviser is selected quickly, -since RITlug is an officially-recognized club and is required to have a faculty -adviser at all times. +*Note*: If off-boarding an adviser, ensure a new adviser is selected quickly. +RITlug is an officially-recognized club and is required to have a faculty adviser at all times. - Contact clubs office to remove former adviser from CampusGroups -- Follow Eboard off-boarding procedures for faculty adviser (see - :doc:`eboard-onboarding-offboarding`) +- Follow eboard off-boarding procedures for faculty adviser (see :doc:`eboard-onboarding-offboarding`) + +- Thank your outgoing faculty adviser for their support (getting a physical gift, like a thank you card signed by club members or a gift card is a nice gesture) -- Thank your outgoing faculty adviser for their support (getting a physical - gift, like a thank you card signed by club members or a gift card is always a - nice gesture) +.. [#] Always ask – RIT clubs office often does not clearly communicate when requirements have changed diff --git a/docs/administration/github-org.rst b/docs/administration/github-org.rst index b759ae1..ee21f7e 100644 --- a/docs/administration/github-org.rst +++ b/docs/administration/github-org.rst @@ -2,28 +2,25 @@ GitHub organization ################### -This page explains how the `RITlug GitHub organization`_ is organized and how -to manage it. +This page explains how the `RITlug GitHub organization`_ is organized and how to manage it. ******* Purpose ******* -The GitHub organization is a central place to manage club projects, membership, -and infrastructure. Most data is static and doesn't change often. Setting up -club projects or adding a new member is when you usually need to interact with -the GitHub organization. +The GitHub organization is a central place to manage club projects, membership, and infrastructure. +Most data is static and does not change often. +Setting up club projects or adding a new member is when you usually need to interact with the GitHub organization. ************ Repositories ************ -There are no restrictions on repositories allowed. Repository creation -permission is granted only to eboard members as a precaution. This approach was -decided to ensure that the current eboard has a chance to review a project -before officially endorsing it underneath our GitHub organization. +There are no restrictions on repositories allowed. +Repository creation permission is granted only to eboard members as a precaution. +This approach was decided to ensure that the current eboard has a chance to review a project before officially endorsing it underneath our GitHub organization. Generally, repository creation should be encouraged rather than discouraged. @@ -33,14 +30,12 @@ Adding new members ****************** There is no criteria for adding new members to the RITlug GitHub organization. -There are no requirements to add new members to the RITlug GitHub organization -other than being an active community member. In the future, if a membership -criteria is developed, this section should be updated. +There are no requirements to add new members to the RITlug GitHub organization other than being an active community member. +In the future, if a membership criteria is developed, this section should be updated. Active community members of RITlug should be added to the GitHub organization. -Adding a new person to the GitHub organization validates their contributions and -activity in the club and helps others be included with projects. Past eboards -intentionally chose a loose definition of membership in GitHub for this reason. +Adding a new person to the GitHub organization validates their contributions and activity in the club and helps others be included with projects. +Past eboards intentionally chose a loose definition of membership in GitHub for this reason. These steps should be followed to add a new member: @@ -56,17 +51,12 @@ These steps should be followed to add a new member: Welcome message =============== -To welcome a new member to GitHub and to notify them of why they were added, -file a new issue in `RITlug/tasks`_ to explain why they were added and how to -set their membership status to public. Past examples can be used as references -([#f1]_ [#f2]_ [#f3]_). +Welcome new members to GitHub and notify them of why they were added. +To do this, file a new issue in `RITlug/tasks`_ to explain why they were added and how to set their membership status to public. +Past examples can be used as references ([#f1]_ [#f2]_ [#f3]_). -Telling the person how to set their membership as public is important. This -instruction should always be included in the welcome message. - -.. [#f1] https://github.com/RITlug/history/issues/12 -.. [#f2] https://github.com/RITlug/history/issues/13 -.. [#f3] https://github.com/RITlug/history/issues/18 +Telling the person how to set their membership as public is important. +This instruction should always be included in the welcome message. ************ @@ -74,8 +64,7 @@ GitHub Teams ************ GitHub Teams are a tool to organize members inside of a GitHub organization. -This also allows for permission matrices for different repositories and -projects. +This also allows for permission matrices for different repositories and projects. .. figure:: /_static/img/github-org-teams.png :alt: GitHub Teams in our organization @@ -86,18 +75,19 @@ There are four teams: #. **Eboard**: Club leadership (grants admin access to all repositories) -#. **Friends of RITlug**: Active participants with the club from outside RIT or - other friends of the club (does not include permissions) +#. **Friends of RITlug**: Active participants with the club from outside RIT or other friends of the club (does not include permissions) -#. **Members**: RIT students, faculty, and staff participating in RITlug (does - not include permissions) +#. **Members**: RIT students, faculty, and staff participating in RITlug (does not include permissions) -#. **TigerOS Team**: `TigerOS`_ project team (grants write access to TigerOS - repositories) +#. **TigerOS Team**: `TigerOS`_ project team (grants write access to TigerOS repositories) Anyone added to the GitHub organization should belong to at least one team. +.. [#f1] https://github.com/RITlug/history/issues/12 +.. [#f2] https://github.com/RITlug/history/issues/13 +.. [#f3] https://github.com/RITlug/history/issues/18 + .. _`RITlug GitHub organization`: https://github.com/RITlug .. _`RITlug/tasks`: https://github.com/RITlug/tasks .. _`TigerOS`: http://tigeros.ritlug.com/ diff --git a/docs/events/club-fairs.rst b/docs/events/club-fairs.rst index 1acd474..bef9944 100644 --- a/docs/events/club-fairs.rst +++ b/docs/events/club-fairs.rst @@ -1,16 +1,14 @@ Club Fairs ========== -RIT has a number of club fairs throughout the year that RITlug can -attend in order to attract more members. Attending (or not) is at the -discretion of the active Eboard. +RIT has a number of club fairs throughout the year that RITlug can attend in order to attract more members. +Attending (or not) is at the discretion of the active Eboard. Staffing -------- -The RITlug table must be staffed by at least one Eboard member. Eboard -can offer staffing the table as a club involvement opportunity and any -number of members can visit or stand with RITlug. +The RITlug table must be staffed by at least one Eboard member. +Eboard can offer staffing the table as a club involvement opportunity and any number of members can visit or stand with RITlug. Anyone staffing the table should be prepared to speak to people. @@ -21,23 +19,18 @@ Setup - Request extra chairs and access to power if needed. -- Put up the RITlug table banner if it is available. Otherwise, try to - have some signage on hand so the table is clearly branded as being a - RITlug presence. +- Put up the RITlug table banner if it is available. + Otherwise, try to have some signage on hand so the table is clearly branded as being a RITlug presence. -- Create a signup sheet on Google Forms to collect the email addresses - of anyone interested in getting involved. Email should suffice, but - name and email can be a good idea (new students may sign up with - their personal email). +- Create a signup sheet on Google Forms to collect the email addresses of anyone interested in getting involved. + Email should suffice, but name and email can be a good idea (new students may sign up with their personal email). After the Fair -------------- -- Invite anyone who signed up with their RIT email to join RITlug on - TheLink. TheLink offers this functionality on the Roster under the - Invite button. +- Invite anyone who signed up with their RIT email to join RITlug on TheLink. + TheLink offers this functionality on the Roster under the Invite button. -- Email anyone who signed up with their personal email and suggest they - join TheLink or the public mailing list for email updates. You can - also refer them to the get-involved page on the website, or - equivalent. Don't annoy them by emailing them repeatedly. +- Email anyone who signed up with their personal email and suggest they join TheLink or the public mailing list for email updates. + You can also refer them to the get-involved page on the website, or equivalent. + Don't annoy them by emailing them repeatedly. diff --git a/docs/events/event-management-system.rst b/docs/events/event-management-system.rst index 1b89507..4d9876e 100644 --- a/docs/events/event-management-system.rst +++ b/docs/events/event-management-system.rst @@ -2,14 +2,13 @@ RIT Event Management System ########################### -This page documents the RIT `Event Management System`_ (EMS), the system RIT -uses to enable students and student organizations to make room reservations and -requests. +This page documents the RIT `Event Management System`_ (EMS). +EMS is the system RIT offers to students and student organizations to make room reservations and requests. -************** -When it's used -************** +*************** +When it is used +*************** RIT EMS is used when you need to make a reservation for a room on RIT's campus. Extra options are enabled on student accounts linked to a student organization. @@ -18,9 +17,8 @@ Extra options are enabled on student accounts linked to a student organization. The official name for our club in RIT's system is *Linux Users Group*. -Account privileges are managed through CampusGroups (see -:doc:`../administration/campusgroups-management`). Make sure eboard members are -current for grant or revoke privileges. +Account privileges are managed through CampusGroups (see :doc:`../administration/campusgroups-management`). +Make sure eboard members are current for grant or revoke privileges. .. figure:: /_static/img/event-management-system-room-options.png :alt: Booking options from RIT EMS with student org privileges @@ -28,7 +26,6 @@ current for grant or revoke privileges. Booking options from RIT EMS with student org privileges - ******** Contacts ******** diff --git a/docs/events/meetings.rst b/docs/events/meetings.rst index 468344f..0f12ef0 100644 --- a/docs/events/meetings.rst +++ b/docs/events/meetings.rst @@ -1,115 +1,80 @@ Meetings ======== -This page covers when meetings happen, the typical RITlug meeting format -and topics, how to plan and announce a meeting, and what to do following -the meeting. +This page covers when meetings happen, the typical RITlug meeting format and topics, how to plan and announce a meeting, and what to do following the meeting. -Note that this is a typical meeting. RITlug holds the occasional -"special" meeting which do not always follow this format (think -elections and similar). +Note that this is a typical meeting. +RITlug holds the occasional "special" meeting which do not always follow this format (think elections and similar). Meeting Checklist (steps are detailed later in the document) ------------------------------------------------------------ -1. Make sure an eboard member will be available and present in the room - prior to the meeting (15 minutes is usually fine). -2. Plan a topic for the meeting (including creating presentations if - necessary) +1. Make sure an eboard member will be available and present in the room prior to the meeting (15 minutes is usually fine). +2. Plan a topic for the meeting (including creating presentations if necessary) 3. Announce the meeting topic -4. Hold the meeting! Prior to a talk, give any club announcements and - introduce the presenter. +4. Hold the meeting! Prior to a talk, give any club announcements and introduce the presenter. 5. Post the talk to the RITlug website, if permitted -6. Ensure an Eboard member is present until the end of the meeting (or - end the meeting early, if absolutely necessary) +6. Ensure an Eboard member is present until the end of the meeting (or end the meeting early, if absolutely necessary) When ---- -Meetings are held Friday evenings 4-6PM. Although late, the room the -club meets in is consistently available during this time so that we can -keep a consistent time. Keeping a consistent time allows members to plan -their schedules around meetings. +Meetings are held Friday evenings 4-6PM. +Although late, the room the club meets in is consistently available during this time so that we can keep a consistent time. +Keeping a consistent time allows members to plan their schedules around meetings. Format ------ -RITlug meetings are casual and often driven by interruption. The -meetings are structured so that the first half of the meeting is -reserved for presentations (planned in advance). These presentations may -not take up the entirety of the first hour. This allows for -presentations to run long and for questions if the club takes interest, -without necessarily constraining them to a shorter time slot than is -ideal. - -Presentations given by club members usually welcome interruption for -questions or observations. This allows for presentations to expand to -suit the interests of those present at the meeting and often leads to -interesting tangents that would otherwise not have the opportunity to -come up. Interruptions are encouraged to be polite by waiting for a -pause or bringing up questions between slides. This is not a typical way -of giving presentations so guest speakers should be warned, or the club -asked to hold their questions to the end, depending on the speaker. +RITlug meetings are casual and often driven by interruption. +The meetings are structured so that the first half of the meeting is reserved for presentations (planned in advance). +These presentations may not take up the entirety of the first hour. +This allows for presentations to run long and for questions if the club takes interest, without necessarily constraining them to a shorter time slot than is ideal. + +Presentations given by club members usually welcome interruption for questions or observations. +This allows for presentations to expand to suit the interests of those present at the meeting and often leads to interesting tangents that would otherwise not have the opportunity to come up. +Interruptions are encouraged to be polite by waiting for a pause or bringing up questions between slides. +This is not a typical way of giving presentations so guest speakers should be warned, or the club asked to hold their questions to the end, depending on the speaker. The remainder of the meeting after the presentation is unstructured. -This provides time for members to experiment with the topic that was -presented, raise questions and concerns, get general tech support, and -openly discuss other facets of the Linux and FOSS worlds. Occasionally, -impromptu presentations may appear during this time as well. - -Splitting the meeting into two sections gives members the option to stay -for only one portion of the meeting. This can be ideal for some due to -classes or other scheduling. Members are free to come and go as they -feel the need. This also seems to promote learning and the club to form -a community, rather than just being a group of people who meet on a -weekly basis. +This provides time for members to experiment with the topic that was presented, raise questions and concerns, get general tech support, and openly discuss other facets of the Linux and FOSS worlds. +Occasionally, impromptu presentations may appear during this time as well. + +Splitting the meeting into two sections gives members the option to stay for only one portion of the meeting. +This can be ideal for some due to classes or other scheduling. +Members are free to come and go as they feel the need. +This also seems to promote learning and the club to form a community, rather than just being a group of people who meet on a weekly basis. Planning and Announcing ----------------------- -Meetings should be planned in advance of the meeting with at least one -presentation. Once the formal topic of the meeting is decided, an -announcement should be sent out to the club. See -`Announcements `__. As part of the announcement -process is handled via Github, presenters should be encouraged to submit -their announcement as a pull request against the website. Once merged, -the eboard should also copy the announcement and send it out via -TheLink. Instructions for sending an announcement are available `in the -Runbook `__ and can be sent with the -request for an announcement. Note that not all presenters may be willing -to submit a pull request or it may not be appropriate to ask them to, so -use discretion when making the request. - -Re-using previous presentations is okay, provided that they haven't been -given for enough time that repeating them will not be repetitive. RITlug -publishes talks (where licensing allows) on the website and pulling from -these is permissible. - -Club members may express interest in covering a particular topic and may -provide their own presentations as well. +Meetings should be planned in advance of the meeting with at least one presentation. +Once the formal topic of the meeting is decided, an announcement should be sent out to the club. +See `Announcements `__. +As part of the announcement process is handled via Github, presenters should be encouraged to submit their announcement as a pull request against the website. +Once merged, the eboard should also copy the announcement and send it out via TheLink. +Instructions for sending an announcement are available `in the Runbook `__ and can be sent with the request for an announcement. +Note that not all presenters may be willing to submit a pull request or it may not be appropriate to ask them to, so use discretion when making the request. + +Re-using previous presentations is okay, provided that they haven't been given for enough time that repeating them will not be repetitive. +RITlug publishes talks (where licensing allows) on the website and pulling from these is permissible. + +Club members may express interest in covering a particular topic and may provide their own presentations as well. After the Meeting ----------------- -If the presenter agrees and licensing allows, request a PDF of the -presentation from the presenter or a link to the presentation on their -website. This should be posted to the RITlug website, also using `the -Runbook instructions `__ which is a similar -process to posting announcements. If the presenter is willing, they may -submit a pull request for their own talk. Do not post the talk without -permission and appropriate licenses, ONLY post talks that RITlug is -permitted to post. +If the presenter agrees and licensing allows, request a PDF of the presentation from the presenter or a link to the presentation on their website. +This should be posted to the RITlug website, also using `the Runbook instructions `__ which is a similar process to posting announcements. +If the presenter is willing, they may submit a pull request for their own talk. +Do not post the talk without permission and appropriate licenses, ONLY post talks that RITlug is permitted to post. -If the presenter is a guest speaker, be sure to thank them for their -time and offer to help them to their next destination if they are -leaving the meeting. Guests invited to RIT by RITlug should have pre and -post-meeting arrangements made in advance and communicated to the guest. +If the presenter is a guest speaker, be sure to thank them for their time and offer to help them to their next destination if they are leaving the meeting. +Guests invited to RIT by RITlug should have pre and post-meeting arrangements made in advance and communicated to the guest. Topics ------ -There aren't any specific restrictions for meeting topics. Topics -usually are Linux-related but also can be related to other open source -technologies, or other technologies in general. Presenting about -anything is permissible as long as it is appropriate and there is -interest from the club. +There aren't any specific restrictions for meeting topics. +Topics usually are Linux-related but also can be related to other open source technologies, or other technologies in general. +Presenting about anything is permissible as long as it is appropriate and there is interest from the club. diff --git a/docs/infrastructure/hosted-server.rst b/docs/infrastructure/hosted-server.rst index db7cf89..67bcf39 100644 --- a/docs/infrastructure/hosted-server.rst +++ b/docs/infrastructure/hosted-server.rst @@ -2,10 +2,11 @@ Hosted server ############# -RITlug has a hosted server in the Institute Hall data center. It's currently -owned and maintained by `Solomon Rubin`_ (Serubin). It is permanently on lend to -RITlug. He remains the primary contact for any major issues. RITlug-related use -is maintained by designated club Server Admins. +RITlug has a hosted server in the Institute Hall data center. +It is currently owned and maintained by `Solomon Rubin`_ (Serubin). +It is permanently on lend to RITlug. +He remains the primary contact for any major issues. +RITlug-related use is maintained by designated club Server Admins. ************** @@ -31,9 +32,8 @@ PowerEdge R410 Server Management ********** -This section is for management of resources on the hosted server. Some parts of -RITlug's infrastructure are hosted in GitHub, like our website (see -:doc:`website`). +This section is for management of resources on the hosted server. +Some parts of RITlug's infrastructure are hosted in GitHub, like our website (see :doc:`website`). Create new VM ============= @@ -79,16 +79,16 @@ When creating a new VM from a template… #. Set `Resource Pool` to `RITLUG` #. Set name and continue #. Resize disk, modify resources as needed -#. Change MAC address in network settings. Use an unallocated MAC from the list on the eboard GitLab and record the new use in the list. +#. Change MAC address in network settings. + Use an unallocated MAC from the list on the eboard GitLab and record the new use in the list. #. Start VM, follow any setup scripts #. Profit! Use and Access ============== -Use and access is limited to members of the executive board. In the future, -there may be opportunities for club members to participate in managing RITlug's -infrastructure. +Use and access is limited to members of the executive board. +In the future, there may be opportunities for club members to participate in managing RITlug's infrastructure. Contacts ======== diff --git a/docs/infrastructure/irc-channel.rst b/docs/infrastructure/irc-channel.rst index 5599ae6..9e045eb 100644 --- a/docs/infrastructure/irc-channel.rst +++ b/docs/infrastructure/irc-channel.rst @@ -4,32 +4,24 @@ The RITlug IRC Channel Overview -------- -RITlug maintains an IRC channel on Freenode, which is open to the -public. RITlug members are free to discuss any topic in the IRC channel, -although it is expected that discussion adheres to RIT and Freenode -policies (academic dishonesty, slander, threats, or anything else deemed -inappropriate by club leadership may result in a warning or a ban at the -discretion of the Op(s)) +RITlug maintains an IRC channel on Freenode, which is open to the public. +RITlug members are free to discuss any topic in the IRC channel, although it is expected that discussion adheres to RIT and Freenode policies (academic dishonesty, slander, threats, or anything else deemed inappropriate by club leadership may result in a warning or a ban at the discretion of the Op(s)) -The IRC channel is available on Freenode as #ritlug. If you're not -familiar with Freenode and/or IRC, you may want to brush up on your IRC -basics. Here's a few things to get you started: +The IRC channel is available on Freenode as #ritlug. +If you're not familiar with Freenode and/or IRC, you may want to brush up on your IRC basics. Here's a few things to get you started: -1. Connect to Freenode using the client of your choosing (IRSSI, Pidgin, - etc) +1. Connect to Freenode using the client of your choosing (IRSSI, Pidgin, etc) - Server: irc.freenode.net - Username: Whatever you go by! - Protocol: IRC - Password: None -2. Set your nick (May not be necessary if you set a username in your - client) +2. Set your nick (May not be necessary if you set a username in your client) - ``/nick `` -3. Register your Nick (required if you will have Op privileges, highly - recommended otherwise) +3. Register your Nick (required if you will have Op privileges, highly recommended otherwise) - ``/msg NickServ register `` - NickServ will email you a confirmation code @@ -43,8 +35,7 @@ Adding a new Op *This requires you to already have Op privileges* -As an Op, you can modify the permissions of other Ops (assuming you have -permission to do so) so you can granularly control access if necessary. +As an Op, you can modify the permissions of other Ops (assuming you have permission to do so) so you can granularly control access if necessary. After signing in and identifying with NickServ (you will be prompted) @@ -53,17 +44,14 @@ After signing in and identifying with NickServ (you will be prompted) /msg ChanServ #ritlug add +AOfiorstv The flags (letters following the +) are detailed in `Flags <#flags>`__. -You can add or remove flags as necessary in the command depending on the -access you want to grant. Some flags can't be granted due to -permissions, such as Founder. +You can add or remove flags as necessary in the command depending on the access you want to grant. Some flags can't be granted due to permissions, such as Founder. For removing an Op, scroll down to Managing Access. Checking Access --------------- -ChanServ allows you to check (if you have permissions to do so) who has -what access to the channel. +ChanServ allows you to check (if you have permissions to do so) who has what access to the channel. :: @@ -79,9 +67,8 @@ Managing Access --------------- You can update a user's access levels after adding them, as necessary. -You MUST add the user, as described in Adding a New Op above, or the -permissions you grant will only be temporary. Access levels are -controlled using what are referred to as `Flags <#flags>`__. +You MUST add the user, as described in Adding a New Op above, or the permissions you grant will only be temporary. +Access levels are controlled using what are referred to as `Flags <#flags>`__. Adding permissions to a user @@ -97,8 +84,7 @@ Removing permissions from a user *(note the +/- in the commands above)* -You can add and remove multiple flags at a time by tacking them onto the -command, for example +You can add and remove multiple flags at a time by tacking them onto the command, for example :: @@ -110,8 +96,7 @@ or by using wildcards (\*), for example /msg ChanServ flags #ritlug -* -Removing a user from the access list (removing all their permissions as -well) +Removing a user from the access list (removing all their permissions as well) :: @@ -146,19 +131,13 @@ Flags are used to grant and revoke access on the channel. Handling Problem Users ---------------------- -Problem users may include users who are frequently disruptive, rude, or -engage in activities that RIT and/or Freenode do not approve of. If a -user becomes a problem, they should be warned and reminded of the -channel policies. If they are a problem repeatedly, then additional -action should be taken. As a reminder, RIT policies apply to all -students whether or not they are on campus at the time of the offense, -if it is against another RIT student or RIT. +Problem users may include users who are frequently disruptive, rude, or engage in activities that RIT and/or Freenode do not approve of. +If a user becomes a problem, they should be warned and reminded of the channel policies. +If they are a problem repeatedly, then additional action should be taken. +As a reminder, RIT policies apply to all students whether or not they are on campus at the time of the offense, if it is against another RIT student or RIT. -It can sometimes be difficult to identify users in IRC. If their real -life identity is known and they are a current RIT student or faculty and -they repeatedly violate RIT policies, they should be reported to the -proper RIT authorities (Public Safety, Student Conduct, or for cases of -academic dishonesty, their department). +It can sometimes be difficult to identify users in IRC. +If their real life identity is known and they are a current RIT student or faculty and they repeatedly violate RIT policies, they should be reported to the proper RIT authorities (Public Safety, Student Conduct, or for cases of academic dishonesty, their department). Problem users in IRC can be kicked from the channel by doing @@ -166,15 +145,13 @@ Problem users in IRC can be kicked from the channel by doing /kick -Repeatedly problematic users can be banned from the channel by name or -by hostmask by doing +Repeatedly problematic users can be banned from the channel by name or by hostmask by doing :: /msg ChanServ akick #ritlug add -You can also specify a reason for the ban by adding it to the end of the -command. Bans can expire after a period of time or can be permanent: +You can also specify a reason for the ban by adding it to the end of the command. Bans can expire after a period of time or can be permanent: :: diff --git a/docs/infrastructure/website.rst b/docs/infrastructure/website.rst index f754830..4ce5975 100644 --- a/docs/infrastructure/website.rst +++ b/docs/infrastructure/website.rst @@ -1,24 +1,19 @@ The Website =========== -RITlug's website is powered by Github pages and stored in a repository -in the RITlug Github organization. It is powered by vanilla Jekyll (no -plugins) as Github pages does not allow plugins for security reasons. In -order to update any aspect of the site, simply push or merge changes to -the repository and the changes will take effect within a few minutes. +RITlug's website is powered by Github pages and stored in a repository in the RITlug Github organization. +It is powered by vanilla Jekyll (no plugins) as Github pages does not allow plugins for security reasons. +In order to update any aspect of the site, simply push or merge changes to the repository and the changes will take effect within a few minutes. Announcements ------------- -This is a quick rundown of how to post an announcement on the RITlug -website. See also `Announcements `__. +This is a quick rundown of how to post an announcement on the RITlug website. +See also `Announcements `__. -- Fork the repository to your own Github account (go to the RITlug - repository and click "fork") -- Clone the repository locally (if desired - you can also create it - online) -- Create a new file in announcements/\_posts named with the convention - 2015-10-02-new-website.md +- Fork the repository to your own Github account (go to the RITlug repository and click "fork") +- Clone the repository locally (if desired - you can also create it online) +- Create a new file in announcements/\_posts named with the convention 2015-10-02-new-website.md - Add front matter to the file :: @@ -35,43 +30,32 @@ website. See also `Announcements `__. - Add the new file to git - Git commit - Git push to your repository -- Open a pull request against the master branch (which is default) of - the RITlug copy of the repository +- Open a pull request against the master branch (which is default) of the RITlug copy of the repository - When your pull is merged, the site will update within a few minutes Talks ----- -This follows the same process as announcements, with a couple of small -tweaks: +This follows the same process as announcements, with a couple of small tweaks: - The files will be put in talks/\_posts -- There is an extra line in the frontmatter called 'slides' which - provides a link to where the slides for the talk can be viewed. This - should be a URL, usually along the lines of /talks/your-talk-name.pdf - if hosted on the RITlug site -- The slides (if hosted on the RITlug site) should be put in the talks - folder, prefaced with the year and semester. Something like - 2015-fall- +- There is an extra line in the frontmatter called 'slides' which provides a link to where the slides for the talk can be viewed. + This should be a URL, usually along the lines of /talks/your-talk-name.pdf if hosted on the RITlug site +- The slides (if hosted on the RITlug site) should be put in the talks folder, prefaced with the year and semester. Something like 2015-fall- - If hosted on the RITlug site, the slides should also be committed Site Source ----------- -This is the structure of the source code for the site, e.g. where to -find anything. Most of the structure should be pretty self explanatory. +This is the structure of the source code for the site, e.g. where to find anything. +Most of the structure should be pretty self explanatory. -The site uses Google's `Material Design Light -template `__, version 1.0. The javascript is patched -to allow for linking to other pages in the tab bar - a feature which -should be built in in version 1.1. +The site uses Google's `Material Design Light template `__, version 1.0. +The javascript is patched to allow for linking to other pages in the tab bar - a feature which should be built in in version 1.1. -The site follows a fairly typical Jekyll setup so you can refer to the -Jekyll documentation. +The site follows a fairly typical Jekyll setup so you can refer to the Jekyll documentation. -Pointer: You can access announcements from within templates using {{ -site.categories.announcements }} and talks using {{ -site.categories.talks }}. +Pointer: You can access announcements from within templates using {{ site.categories.announcements }} and talks using {{ site.categories.talks }}. .. raw:: html @@ -108,5 +92,4 @@ site.categories.talks }}. Developing and Previewing ------------------------- -`Refer to the README in the site -repository `__ +`Refer to the README in the site repository `__ diff --git a/docs/roles/president.rst b/docs/roles/president.rst index 50b5d9a..6ccb702 100644 --- a/docs/roles/president.rst +++ b/docs/roles/president.rst @@ -1,10 +1,9 @@ Eboard: President ================= -The president is one of the elected members of the executive board (i.e. -"eboard"). The president is directly responsible for managing the club and -coordinating with other eboard members. This page explains more about the -responsibilities and role of the president. +The president is one of the elected members of the executive board (i.e. "eboard"). +The president is directly responsible for managing the club and coordinating with other eboard members. +This page explains more about the responsibilities and role of the president. Description @@ -16,23 +15,16 @@ Description Eligibility requirements ^^^^^^^^^^^^^^^^^^^^^^^^ -< basic eligiblity requirements – what if someone is on co-op? away from -campus? working remote? is under academic suspension (i.e. low GPA)? +< basic eligiblity requirements – what if someone is on co-op? away from campus? working remote? is under academic suspension (i.e. low GPA)? > Responsibilities ---------------- -< responsibilities and routine work that someone in this position is directly -accountable for – what do they do and what should other eboard members expect -from this person? > +< responsibilities and routine work that someone in this position is directly accountable for – what do they do and what should other eboard members expect from this person? > Resources --------- -< any resources, pages, or other things someone coming into this should read to -be informed and prepared to take on the role – probably best as a list of -links! > - - +< any resources, pages, or other things someone coming into this should read to be informed and prepared to take on the role – probably best as a list of links! > diff --git a/docs/roles/project-coordinator.rst b/docs/roles/project-coordinator.rst index fe3e514..3db06df 100644 --- a/docs/roles/project-coordinator.rst +++ b/docs/roles/project-coordinator.rst @@ -1,31 +1,25 @@ Eboard: Project coordinator =========================== -The project coordinator is one of the elected members of the executive board -(i.e. "eboard"). The project coordinator is directly responsible for managing -different projects in the club. Sometimes, the project coordinator may act as a -project lead for a specific project. This page explains more about the -responsibilities and role of the project coordinator. +The project coordinator is one of the elected members of the executive board (i.e. "eboard"). +The project coordinator is directly responsible for managing different projects in the club. +Sometimes, the project coordinator may act as a project lead for a specific project. +This page explains more about the responsibilities and role of the project coordinator. Description ----------- -The project coordinator is responsible for ensuring that all club projects have -the resources needed to continue developing. This may include monetary -resources, connections to mentors or the like and infrastructure to host the -projects. +The project coordinator is responsible for ensuring that all club projects have the resources needed to continue developing. +This may include monetary resources, connections to mentors or the like and infrastructure to host the projects. Eligibility requirements ^^^^^^^^^^^^^^^^^^^^^^^^ -The project coordinator must maintain good academic standing as defined by RIT -to remain a member of eboard. Due to the hands on nature of the role, the -project coordinator must be available in person during club and eboard -meetings. If needed, a temporary replacement may be appointed to fill the role -while the project coordinator is out on co-op. In that case there should be good -communication between the the two people in order to facilitate a smooth -transition. +The project coordinator must maintain good academic standing as defined by RIT to remain a member of eboard. +Due to the hands on nature of the role, the project coordinator must be available in person during club and eboard meetings. +If needed, a temporary replacement may be appointed to fill the role while the project coordinator is out on co-op. +In that case there should be good communication between the the two people in order to facilitate a smooth transition. Responsibilities @@ -43,8 +37,6 @@ Resources - `The runbook `_ - A sample `RITlug project `_ -- `Freenode webchat `_ to ask questions about specific - projects +- `Freenode webchat `_ to ask questions about specific projects - The `TigerOS landing page `_ - #fedora-respins on freenode was helpful for questions with building TigerOS - diff --git a/docs/roles/secretary.rst b/docs/roles/secretary.rst index 8f9afd1..f0fbe4f 100644 --- a/docs/roles/secretary.rst +++ b/docs/roles/secretary.rst @@ -1,10 +1,9 @@ Eboard: Secretary ================= -The secretary is one of the elected members of the executive board (i.e. -"eboard"). The secretary helps with written communication and keeping club -records updated and current. This page explains more about the responsibilities -and role of the secretary. +The secretary is one of the elected members of the executive board (i.e. "eboard"). +The secretary helps with written communication and keeping club records updated and current. +This page explains more about the responsibilities and role of the secretary. Description @@ -16,23 +15,16 @@ Description Eligibility requirements ^^^^^^^^^^^^^^^^^^^^^^^^ -< basic eligiblity requirements – what if someone is on co-op? away from -campus? working remote? is under academic suspension (i.e. low GPA)? +< basic eligiblity requirements – what if someone is on co-op? away from campus? working remote? is under academic suspension (i.e. low GPA)? > Responsibilities ---------------- -< responsibilities and routine work that someone in this position is directly -accountable for – what do they do and what should other eboard members expect -from this person? > +< responsibilities and routine work that someone in this position is directly accountable for – what do they do and what should other eboard members expect from this person? > Resources --------- -< any resources, pages, or other things someone coming into this should read to -be informed and prepared to take on the role – probably best as a list of -links! > - - +< any resources, pages, or other things someone coming into this should read to be informed and prepared to take on the role – probably best as a list of links! > diff --git a/docs/roles/treasurer.rst b/docs/roles/treasurer.rst index 0155885..12742e3 100644 --- a/docs/roles/treasurer.rst +++ b/docs/roles/treasurer.rst @@ -1,33 +1,29 @@ Eboard: Treasurer ================= -The treasurer is one of the elected members of the executive board (i.e. -"eboard"). The treasurer is directly responsible for managing the club's -financial resources and budget. The treasurer also helps plan financial -purchases for the club. This page explains more about the responsibilities and -role of the treasurer. +The treasurer is one of the elected members of the executive board (i.e. "eboard"). +The treasurer is directly responsible for managing the club's financial resources and budget. +The treasurer also helps plan financial purchases for the club. +This page explains more about the responsibilities and role of the treasurer. Description ----------- -The base responsibility is managing and maintaining club budget throughout the -academic year. Other responsibilities are included in this role. These aspects -are… +The base responsibility is managing and maintaining club budget throughout the academic year. +Other responsibilities are included in this role. These aspects are… - Organizing fundraiser activities - Record-keeping for club expenses (e.g. project materials) -- Ordering club-branded merchandise as necessary (including shirts, posters, - banners, stickers, etc.) +- Ordering club-branded merchandise as necessary (including shirts, posters, banners, stickers, etc.) Eligibility requirements ^^^^^^^^^^^^^^^^^^^^^^^^ -The treasurer must be in good academic standing to maintain their position. A -club treasurer should be available in-person for club and eboard meetings. -However, as treasurer is a mandatory position per club guidelines, the treasurer -may be remote and participate remote (e.g. co-op, study abroad, etc.). +The treasurer must be in good academic standing to maintain their position. +A club treasurer should be available in-person for club and eboard meetings. +However, as treasurer is a mandatory position per club guidelines, the treasurer may be remote and participate remote (e.g. co-op, study abroad, etc.). Responsibilities @@ -45,5 +41,4 @@ Resources - `Runbook `_ - `RIT Club Management `_ - `Financial Certification `_ -- `RITlug logo source files `_ - +- `RITlug logo source files `_ diff --git a/docs/roles/vice-president.rst b/docs/roles/vice-president.rst index e1e28b8..4b357a4 100644 --- a/docs/roles/vice-president.rst +++ b/docs/roles/vice-president.rst @@ -1,12 +1,10 @@ Eboard: Vice President ====================== -The vice president is one of the elected members of the executive board (i.e. -"eboard"). The vice president is directly responsible for helping the president -carry out their responsibilities and help manage the overall club. Usually, the -president and vice president maintain a close relationship where -responsibilities often swap between the two. This page explains more about the -responsibilities and role of the vice president. +The vice president is one of the elected members of the executive board (i.e. "eboard"). +The vice president is directly responsible for helping the president carry out their responsibilities and help manage the overall club. +Usually, the president and vice president maintain a close relationship where responsibilities often swap between the two. +This page explains more about the responsibilities and role of the vice president. Description @@ -19,14 +17,13 @@ The vice president assists the president where possible. This includes… #. Writing meeting agendas #. Interacting with guest speakers / visiting companies -There is a lot of overlap between the president and vice president. These four -items are the primary responsibilities. There are other secondary tasks outlined -below. +There is a lot of overlap between the president and vice president. +These four items are the primary responsibilities. +There are other secondary tasks outlined below. The vice president also supports the president when they need additional help. -This could include anything from fundraising to event planning. Historically, -the vice president takes on external event planning, like fundraising and -coordinating conference presentations / booths. +This could include anything from fundraising to event planning. +Historically, the vice president takes on external event planning, like fundraising and coordinating conference presentations / booths. Eligibility requirements @@ -38,15 +35,13 @@ Eligibility requirements * Must participate in the club for longer than full semester - Responsibilities ---------------- * Sending / reviewing weekly announcements * If president is unable to write, vice president assists * Maintaining presentation schedule - * Coordinating with club community to find speakers, engaging with outside - visitors to the university + * Coordinating with club community to find speakers, engaging with outside visitors to the university * Planning external events * Fundraising * Conference presence diff --git a/docs/tasks/announcements.rst b/docs/tasks/announcements.rst index 2415dc8..1955b88 100644 --- a/docs/tasks/announcements.rst +++ b/docs/tasks/announcements.rst @@ -4,27 +4,19 @@ Announcements You mean there's more than place for announcements? --------------------------------------------------- -As of 2017, RITlug has three main channels for sending announcements: -the RITlug website (a.k.a. Google Groups), TheLink@RIT, and a Mailchimp -mailing list. Announcements posted on the RITlug website (via git) are -automatically emailed to the public mailing list on Google Groups. IFTTT -picks up the git commit and posts it to the Google Groups mailing list. -Mailchimp was started during fall 2017 during the Club Fair, but it -should be avoided if possible. Unfortunately, there is no current way to -add to the private TheLink@RIT mailing list (or vice versa). - -In order to post a club-wide announcement, create a new post on the -website (see `The Website `__) **first**. -Commit and push the post. Then, take the text and paste it into an email -to the roster on TheLink. You can also take a copy and pasted version to -Mailchimp as well. - -Although it isn't the most fluid way of doing things, make sure all -announcements are sent out through TheLink as it seems to reach people -much more effectively (it's also our largest mailing list of the three). -TheLink roster only allows people with RIT accounts, hence the -additional Google Groups and Mailchimp lists. All RIT-affiliated -individuals should be on TheLink rather than Google Groups. +As of 2017, RITlug has three main channels for sending announcements: the RITlug website (a.k.a. Google Groups), TheLink@RIT, and a Mailchimp mailing list. +Announcements posted on the RITlug website (via git) are automatically emailed to the public mailing list on Google Groups. +IFTTT picks up the git commit and posts it to the Google Groups mailing list. +Mailchimp was started during fall 2017 during the Club Fair, but it should be avoided if possible. +Unfortunately, there is no current way to add to the private TheLink@RIT mailing list (or vice versa). + +In order to post a club-wide announcement, create a new post on the website (see `The Website `__) **first**. +Commit and push the post. Then, take the text and paste it into an email to the roster on TheLink. +You can also take a copy and pasted version to Mailchimp as well. + +Although it isn't the most fluid way of doing things, make sure all announcements are sent out through TheLink as it seems to reach people much more effectively (it's also our largest mailing list of the three). +TheLink roster only allows people with RIT accounts, hence the additional Google Groups and Mailchimp lists. +All RIT-affiliated individuals should be on TheLink rather than Google Groups. Posting Announcements on the Website ------------------------------------ @@ -34,8 +26,7 @@ Posting Announcements on the Website Posting Announcements via TheLink --------------------------------- -**THIS IS ONLY MAINTAINED FOR DOCUMENTATION PURPOSES AND HAS BEEN -DEPRECATED BY RIT** +**THIS IS ONLY MAINTAINED FOR DOCUMENTATION PURPOSES AND HAS BEEN DEPRECATED BY RIT** *This is available only to eboard members on TheLink.* @@ -44,16 +35,12 @@ DEPRECATED BY RIT** 3. Click the button that says "Messaging". 4. Click "Create Relay". 5. On the page that appears, click the "Edit" button under step 1. - Check the boxes. To send an email to the entire club, check the box - named "Member". + Check the boxes. To send an email to the entire club, check the box named "Member". 6. Click "Close". -7. Add a name (usually the email subject line). This is how the email - is listed for posterity in TheLink@RIT but otherwise doesn't - matter.. +7. Add a name (usually the email subject line). + This is how the email is listed for posterity in TheLink@RIT but otherwise doesn't matter.. 8. Click "Generate". 9. Copy and paste the email link into your email client of choice. 10. Type your announcement, click "send". Done! -TheLink will forward your email out to the list of members you selected -in the next few minutes, with your email address as the "reply-to" link, -from "Linux Users Group". +TheLink will forward your email out to the list of members you selected in the next few minutes, with your email address as the "reply-to" link, from "Linux Users Group". diff --git a/docs/tasks/semester-checklist.rst b/docs/tasks/semester-checklist.rst index 4b2df1a..08f6975 100644 --- a/docs/tasks/semester-checklist.rst +++ b/docs/tasks/semester-checklist.rst @@ -1,14 +1,9 @@ Semester Checklist ================== -A quick checklist of tasks that need to be completed at the start of -every semester. +A quick checklist of tasks that need to be completed at the start of every semester. -- Reserve the meeting room by speaking to the lab manager (requires a - signature from the president and vice president). Get set up with - swipe access if need be. -- Complete any outstanding eboard `transition - tasks `__ -- Set up a meeting with the club faculty adviser to discuss plans for - the semester +- Reserve the meeting room by speaking to the lab manager (requires a signature from the president and vice president). Get set up with swipe access if need be. +- Complete any outstanding eboard `transition tasks `__ +- Set up a meeting with the club faculty adviser to discuss plans for the semester - Update the website and thelink for the new semester