Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converting community-wide-resources to rst #230

Merged
merged 42 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
4e11042
changing to rst
Oct 6, 2024
b264bfe
changed file extension
Oct 6, 2024
fdd7b13
Update chapter.rst
Iqmaa Oct 6, 2024
f5a4c49
correcting conversion site errors
Oct 6, 2024
45a1b82
Merge branch 'converting-to-rst' of https://github.com/Iqmaa/mautic-c…
Oct 6, 2024
d14221b
adding link files and adding to table of content
Oct 7, 2024
5104dad
Update index.rst
Iqmaa Oct 7, 2024
05d16dd
Update Jono-bacon-video.py
Iqmaa Oct 7, 2024
63042f3
implementing revisions
Oct 8, 2024
95bf191
Update Art-of-community-book.py
Iqmaa Oct 8, 2024
9f10127
Update Art-of-community-book.py
Iqmaa Oct 8, 2024
be0d95c
Merge branch 'main' into converting-to-rst
Iqmaa Oct 8, 2024
3f1f5e8
resolved conflicts
Oct 13, 2024
75df996
conflicts
Oct 13, 2024
9ce9d68
Merge branch 'main' into converting-to-rst
Iqmaa Oct 13, 2024
642adbf
Update index.rst
Iqmaa Oct 13, 2024
f779bb6
Merge branch 'main' into converting-to-rst
RCheesley Oct 21, 2024
5bc9d72
Update index.rst
Iqmaa Oct 21, 2024
e22d0d1
Update docs.md
Iqmaa Oct 21, 2024
22980c9
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
5808e96
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
e0878e4
Update docs/pages/07.community-wide-resources/03.avoiding-burnout/doc…
Iqmaa Oct 21, 2024
a847173
Update docs/pages/07.community-wide-resources/03.avoiding-burnout/doc…
Iqmaa Oct 21, 2024
c8a7663
Update docs/pages/07.community-wide-resources/03.avoiding-burnout/doc…
Iqmaa Oct 21, 2024
f914b72
Update docs/pages/07.community-wide-resources/04.getting-help-in-a-cr…
Iqmaa Oct 21, 2024
43d3ea3
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
782d1b2
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
1f69da5
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
61e3ff4
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
007c70d
Update docs/pages/07.community-wide-resources/02.meetings/12.how-to-p…
Iqmaa Oct 21, 2024
9d30cea
Update chapter.rst
Iqmaa Oct 21, 2024
4b77703
Move files to correct folder path location
RCheesley Oct 21, 2024
bb20762
Vale fixes, RST fixes
RCheesley Oct 21, 2024
2133363
Turning off Vale as it's a direct quote from the book
RCheesley Oct 21, 2024
7017e60
Vale fixes
RCheesley Oct 21, 2024
de1ae70
Vale fixes
RCheesley Oct 21, 2024
c37e9ce
Vale fixes TODO content needs updating.
RCheesley Oct 22, 2024
a880664
Add phrases to accept list
RCheesley Oct 22, 2024
62adb03
More vale fixes
RCheesley Oct 22, 2024
5d19740
Fix filename typo :blush:
RCheesley Oct 22, 2024
4765e73
Fix failing build warnings
RCheesley Oct 22, 2024
613feb7
Fix abbreviated heading, remove no longer available Kubuntu link
RCheesley Oct 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,10 @@ The vision is that it grows over time as the teams and governance structure evol
:hidden:

about/what_is_mautic

.. toctree::
:maxdepth: 2
:caption: Pages
:hidden:

Pages/Community-wide-resources
7 changes: 7 additions & 0 deletions docs/links/Art-of-community-book.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "The Art of Community"
link_text = "The Art of Community"
link_url = "http://www.artofcommunityonline.org/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/Jono-bacon-video.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Jono Bacon's how to prevent burnout video"
link_text = "Jono Bacon's how to prevent burnout video"
link_url = "https://www.youtube.com/watch?v=WC1bpYGoB7s"

link.xref_links.update({link_name: (link_text, link_url)})
6 changes: 6 additions & 0 deletions docs/links/everytimezone.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from . import link

link_name = "everytimezone"
link_text = "everytimezone"
link_url = "https://everytimezone.com/"
link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/kubuntu-link.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Kubuntu"
link_text = "Kubuntu"
link_url = "https://wiki.kubuntu.org/BuildingCommunity/Burnout/Help"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/mautic-google-drive.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Mautic Google Drive"
link_text = "Mautic Google Drive"
link_url = "https://drive.google.com/drive/folders/1lUQyFnrPEZKlrmhP9HedxSnDGY3StMXx"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/mautic-meeting-parser.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Mautic Meeting Parser"
link_text = "Mautic Meeting Parser"
link_url = "https://github.com/RCheesley/mautic-meeting-parser"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/suicide-prevention-lifeline.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Suicide Prevention Lifeline"
link_text = "Suicide Prevention Lifeline"
link_url = "http://www.suicidepreventionlifeline.org/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/wikipedia.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Wikipedia"
link_text = "Wikipedia"
link_url = "https://en.wikipedia.org/wiki/List_of_suicide_crisis_lines"

link.xref_links.update({link_name: (link_text, link_url)})
Iqmaa marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
========================
Community-wide resources
========================
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
========
Meetings
========


Meetings
==========

As a widely distributed team of volunteers, we work together
collaboratively using both synchronous and asynchronous meetings.

This section provides some useful resources and suggestions for how to
run successful community meetings.
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
======================
Slack (async) meetings
======================

--------------

Slack threads are a great way to hold meetings because:

- They don’t rely on everybody being available to attend the meeting at
a specific time - often async meetings are open for 24 hours
- They don’t require the ability to keep pace with a verbal
conversation, which can be tricky for those with disabilities or for
whom English is not their first language
- There is a written record of the meeting which can be easily exported

We use asynchronous Slack meetings heavily in the Mautic community, and
it’s likely that you’ll be called upon at some point to run one!

Running an asynchronous Slack meeting
=====================================

Here are some tips for running a great meeting:

1. Prepare for the meeting as you would for any other - share an agenda
at least 24 hours before the meeting is due to start, ideally on
Slack and on the forums, to remind people, to give them time to
prepare, and to encourage involvement/engagement
2. Send a reminder 24 hours before the meeting in the relevant Slack
channel with the agenda - mention people directly if they are a
required attendee
3. Prepare your topics in advance based on the agenda, so that you can
copy and paste them into the Slack channel without manually typing
them at the time. You can send them to yourself in Slack, so that you
have an easy-to-access record!
4. Remember to use the welcome post and the introduction thread - this
welcomes people, explains how the meeting works, and allows people to
say who they are, and what they do - don’t assume that people joining
will know this, they might be completely new to the community!
5. Take the meeting at the normal pace you would a regular meeting -
give people time to chime in on the topic and have the discussions
before posting the next topic. This helps to avoid distraction during
the meeting and thread-jumping!
6. Always welcome new meeting attendees, and follow up if people have
dropped off and stopped attending
7. Encourage participation by mentioning people who might be interested
in discussing the topic, or be interested in taking on a task
8. Close the meeting by thanking people for joining
9. Don’t forget to export the notes 24hrs (ish) after the meeting
started

Exporting Slack meetings
========================

We use a fork of a Chrome extension created by the Drupal community in
order to scrape Slack meeting notes into HTML, which can then be posted
onto the forums.

Instructions are provided in the Github repo:
https://github.com/RCheesley/mautic-meeting-parser

Sample meeting structure
========================

Welcome message
---------------

Welcome to the team meeting!

If you haven’t done an asynchronous meeting before, please respond in
threads :slightly_smiling_face:

Also note you can start a reply with :bust_in_silhouette: to be anon, or
:no_entry_sign: to go off the record and not be included in the notes,
which will be exported and saved to Google Docs, and posted on the
Community Forums.

The meeting will be open for 24 hours, after which the notes will be
exported. People may comment thereafter but these won’t be included in
the notes.

Let’s get going! :arrow_down:

Topics
------

:zero:- Introductions : Who are you, where are you based, and how are you
involved with this team?

:one:- Review last meeting’s notes and actions (Share a link to the notes
in a threaded reply, and call out any actions as sub tasks)

:one:.:one:- Action item 1
:one:.:two:- Action item 2

:two:- Review Trello tasks (share a link to the Trello board in a
threaded reply, and call out any tasks as appropriate)

:two:.:one:- Task 1 (Link to task in a threaded reply, brief
explanation of status or actions needed)

(continue through the open tasks)

:three:- Any other business

(Thank people for participating and give the date/time/format for the
next meeting and who will be leading it)
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
======================
Slack (async) meetings
======================

--------------

Slack threads are a great way to hold meetings because:

- They don’t rely on everybody being available to attend the meeting at
a specific time - often async meetings are open for 24 hours
- They don’t require the ability to keep pace with a verbal
conversation, which can be tricky for those with disabilities or for
whom English is not their first language
- There is a written record of the meeting which can be easily exported

We use asynchronous Slack meetings heavily in the Mautic community, and
it’s likely that you’ll be called upon at some point to run one!

Running an asynchronous Slack meeting
=====================================

Here are some tips for running a great meeting:

1. Prepare for the meeting as you would for any other - share an agenda
at least 24 hours before the meeting is due to start, ideally on
Slack and on the forums, to remind people, to give them time to
prepare, and to encourage involvement/engagement
2. Send a reminder 24 hours before the meeting in the relevant Slack
channel with the agenda - mention people directly if they are a
required attendee
3. Prepare your topics in advance based on the agenda, so that you can
copy and paste them into the Slack channel without manually typing
them at the time. You can send them to yourself in Slack, so that you
have an easy-to-access record!
4. Remember to use the welcome post and the introduction thread - this
welcomes people, explains how the meeting works, and allows people to
say who they are, and what they do - don’t assume that people joining
will know this, they might be completely new to the community!
5. Take the meeting at the normal pace you would a regular meeting -
give people time to chime in on the topic and have the discussions
before posting the next topic. This helps to avoid distraction during
the meeting and thread-jumping!
6. Always welcome new meeting attendees, and follow up if people have
dropped off and stopped attending
7. Encourage participation by mentioning people who might be interested
in discussing the topic, or be interested in taking on a task
8. Close the meeting by thanking people for joining
9. Don’t forget to export the notes 24hrs (ish) after the meeting
started

Exporting Slack meetings
========================

We use a fork of a Chrome extension created by the Drupal community in
order to scrape Slack meeting notes into HTML, which can then be posted
onto the forums.

Instructions are provided in the Github repo:
https://github.com/RCheesley/mautic-meeting-parser

Sample meeting structure
========================

Welcome message
---------------

Welcome to the team meeting!

If you haven’t done an asynchronous meeting before, please respond in
threads :slightly_smiling_face:

Also note you can start a reply with :bust_in_silhouette: to be anon, or
:no_entry_sign: to go off the record and not be included in the notes,
which will be exported and saved to Google Docs, and posted on the
Community Forums.

The meeting will be open for 24 hours, after which the notes will be
exported. People may comment thereafter but these won’t be included in
the notes.

Let’s get going! :arrow_down:

Topics
------

:zero:- Introductions : Who are you, where are you based, and how are you
involved with this team?

:one:- Review last meeting’s notes and actions (Share a link to the notes
in a threaded reply, and call out any actions as sub tasks)

:one:.:one:- Action item 1
:one:.:two:- Action item 2

:two:- Review Trello tasks (share a link to the Trello board in a
threaded reply, and call out any tasks as appropriate)

:two:.:one:- Task 1 (Link to task in a threaded reply, brief
explanation of status or actions needed)

(continue through the open tasks)

:three:- Any other business

(Thank people for participating and give the date/time/format for the
next meeting and who will be leading it)
Loading