From 5541bc8c70b02922def066bce8f18a7496132603 Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Mar 15 2018 21:31:48 +0000 Subject: [PATCH 1/2] Update CommOps overview for 2018 --- diff --git a/_distro_map.yml b/_distro_map.yml index 5a9f6da..75624b6 100644 --- a/_distro_map.yml +++ b/_distro_map.yml @@ -7,5 +7,5 @@ fedora: site_url: https://docs.fedoraproject.org/ branches: master: - name: Rawhide + name: " " dir: master diff --git a/docs/attributes.adoc b/docs/attributes.adoc index a6cbd95..d4a4d33 100644 --- a/docs/attributes.adoc +++ b/docs/attributes.adoc @@ -1,2 +1,4 @@ +:COMMBLOG: https://communityblog.fedoraproject.org +:FEDMSG: http://www.fedmsg.com/ :FWIKI: https://fedoraproject.org/wiki :YEAR: 2018 diff --git a/docs/index.adoc b/docs/index.adoc new file mode 100644 index 0000000..daf21ee --- /dev/null +++ b/docs/index.adoc @@ -0,0 +1,277 @@ +include::docs/attributes.adoc[] + += Fedora Community Operations (CommOps) + +image::docs/_static/img/commops-logo.png[CommOps logo] + +Community Operations (CommOps) addresses community architecture and infrastructure in Fedora. +CommOps provides tools, resources, and utilities for different sub-projects of Fedora to improve effective communication. +The following areas are examples of where CommOps focuses: + +* Work closely with https://docs.fedoraproject.org/fedora-project/council/fcaic.html[Fedora Community Action and Impact Coordinator] to prioritize key focus areas +* Assist https://docs.fedoraproject.org/fedora-project/council/fpgm.html[Fedora Program Manager] with release preparations +* Support preparation and execution of Fedora Elections +* Work with sub-projects and teams to improve on-boarding methods and practices +* Use metrics and data to improve understanding of Fedora community +** Support development of metrics tooling +* And more (detailed fully below) + + +[[find-commops]] +== Where to find CommOps + +The CommOps team uses a mailing list and https://en.wikipedia.org/wiki/Internet_Relay_Chat[IRC] channel to communicate. +The mailing list is best for _asynchronous_ communication. +The CommOps IRC channel on the https://freenode.net/[Freenode IRC network] is best for _synchronous_ communication. + +Mailing list:: commops [at] lists [dot] fedoraproject [dot] org (https://lists.fedoraproject.org/admin/lists/commops.lists.fedoraproject.org/[subscribe here]) +IRC channel:: irc://irc.freenode.net/#fedora-commops[#fedora-commops] on Freenode + +First time using IRC? +Look into https://opensource.com/article/17/5/introducing-riot-IRC[Riot], a free and open source client that connects to various IRC networks. +Riot also keeps you connected to IRC even when you're not at the keyboard. + + +[[workflow]] +== Workflow + +CommOps uses a ticket-based workflow to keep track of our work. +The repository with tickets is on https://pagure.io/[Pagure]. +The repository is named https://pagure.io/fedora-commops[fedora-commops]. +Tickets are found under the _https://pagure.io/fedora-commops/issues[Issues]_ menu. + +Various tags are listed at the top of the _Issues_ page. +For good beginner tasks, look at the _https://pagure.io/fedora-commops/issues?status=Open&tags=good+first+issue[good first issue]_ tag. + + +[[meetings]] +== Meetings + +CommOps holda a meeting once a week via IRC to check in our tasks and plan ahead. +Check the https://apps.fedoraproject.org/calendar/commops/[CommOps calendar] for the current date and time. + +Past meeting minutes are recorded in [https://meetbot.fedoraproject.org/teams/commops/[Meetbot]. + + +[[meeting-format]] +=== Meeting format + +The upcoming meeting agenda is found on the Fedora https://infinote.fedoraproject.org/cgit/infinote/tree/meeting-templates/fedora-commops-meeting-next[Infinote server]. +Meetings follow an agenda split into five parts: + +. **Roll call**: Waiting for others to arrive, opportunity to introduce yourself and ask general questions +. **Announcements**: Any news or updates to share +. **Action items from last meeting**: Follow-up on `#action` items from previous meeting +. **Tickets**: Discussion and follow-up on tickets https://pagure.io/fedora-commops/issues?status=Open&tags=meeting[marked for meetings] +. **Open floor**: General discussion or comments + + +[[what-commops-does]] +== What CommOps does + +CommOps focuses on a few key areas, both technical and non-technical. + +=== Culture + +The Fedora Project builds and ships a Linux distribution, but there is a community behind the technical work and planning. +The Fedora community represents a set of ethics and values to how we build our distribution. +These ethics and values create the culture of the Fedora Project. +When working in the community, mindfulness of this culture enriches and supports the different sub-communities inside of Fedora. + +CommOps builds community infrastructure of support and acceptance for the culture of the Fedora community. +In Fedora, we have the https://docs.fedoraproject.org/fedora-project/project/fedora-overview.html#what-is-fedora-all-about[Four Foundations] to represent our community culture. +The _Friends_ part of the Four Foundations is there for a reason. +The community infrastructure CommOps assists with builds on top of the _Friends_ foundation. +People enjoy contributing in a community where they feel valued for who they are and what they bring to the community, not just that they are useful. +CommOps supports this through some of our tasks relating to culture. + +Examples of things we help with to build and support the culture of the Fedora community: + +* https://pagure.io/fedora-commops/issue/17[Interviewing Fedora community members] +* https://pagure.io/fedora-commops/issue/110[Fedora Appreciation Week] +* https://pagure.io/fedora-commops/issue/138[Top Badgers of the Year] + +=== Elections + +There are a few elected bodies in Fedora, such as the https://docs.fedoraproject.org/fedora-project/council/charter.html[Fedora Council], https://docs.fedoraproject.org/fedora-project/subprojects/mindshare/mindshare.html[Mindshare Committee], and https://docs.fedoraproject.org/fedora-project/subprojects/fesco/fesco.html[FESCo]. +Every new Fedora release, the community holds elections for these bodies. +Each election takes "wrangling" work to pull together. +This includes calling for nominations, conducting interviews with candidates, and raising awareness during the voting window. + +CommOps supports the https://docs.fedoraproject.org/fedora-project/council/fpgm.html[Fedora Program Manager] in organizing and executing elections. +These responsibilities consist of curating content on the https://docs.fedoraproject.org/fedora-project/subprojects/mindshare/docs/community-blog.html[Community Blog], creating interview templates, and outreach to grow awareness. + +Examples of things we do to help organize and execute Fedora elections: + +* https://pagure.io/fedora-commops/issue/7[Fedora Elections and CommOps Coverage] +* https://pagure.io/fedora-commops/issue/19[Improve automation of Elections communication] +* https://pagure.io/fedora-commops/issue/93[Better explain roles of Council and FESCo] +* https://pagure.io/fedora-commops/issue/107[Automated Fedocal reminders to send to all mailing lists for upcoming Elections] +* https://pagure.io/fedora-commops/issue/112[Create August 2017 election interview templates for candidates] + +=== Messaging and storytelling + +Messaging and storytelling bring the "story" of the Fedora Project to both the contributor and user community. +Every year, a https://mattdm.org/fedora/2018devconf/DevConfcz2018Charts.pdf[couple thousand people] work on Fedora. +Messaging is a form of storytelling: we bring the message of what we _as a community_ are doing out to others. +Others include our contributors working in other areas of the project and users interested in what the Fedora community produces. +When we share our message with each other, we are mindful of other work happening in the Fedora community. +Communicating the story of Fedora keeps our contributors marching in step together towards our goals. +Our users better understand the goals and objectives of Fedora and how we plan to get there. + +CommOps supports messaging by working with other sub-projects and teams to tell their own stories. +CommOps provides the help to "dig out" the stories and the tools to share them widely. +This includes tasks like interviews, sharing activities by Fedora contributors, running retrospectives, and more. +These tasks keep contributors in sync with what we're working on. +They are direct actions to keep everyone on the same page. + +Examples of things we do to support messaging and tell stories: + +* https://pagure.io/fedora-commops/issue/4[Interviews about goals for team sprints] +* https://pagure.io/fedora-commops/issue/66[Call for nominations of a Working Group] +* https://pagure.io/fedora-commops/issue/98[Covering upcoming talks by Fedora contributors at a major conference] +* https://pagure.io/fedora-commops/issue/100["Help Wanted" columns] +* https://pagure.io/fedora-commops/issue/129[Year in Review blog series] + +=== Metrics + +CommOps measures community health and engagement through extensive metrics and data available about Fedora. +{FEDMSG}[fedmsg] is a messaging bus with data about activity in the Fedora community. +The data includes activity like git commits, new blog posts, wiki page edits, software build status, IRC meeting notes, and more. +CommOps works with fedmsg to tell stories about our community, but specific types of stories. +The stories told with metrics are helpful to understand what we may be doing right or wrong. +It gives us a data-driven way to understand our huge community. + +CommOps directly supports metrics in Fedora through development time and data-driven storytelling. +Some members develop existing software or build new scripts to analyze data. +Others use the data to write reports or studies on how the Fedora community works. +Ultimately, metrics are a largely technical area that CommOps helps with. + +Examples of metrics work and data-driven storytelling we do: + +* https://pagure.io/fedora-commops/issue/32[Analyzing Fedora contributor activity] +* https://pagure.io/fedora-commops/issue/88[Fedora release party metrics] +* https://pagure.io/fedora-commops/issue/109[Understanding contributor activity by geographic location] + +=== Supporting sub-projects + +CommOps assists other sub-projects and teams in following best practices and communicating effectively. +We work with other teams to help them on-board new contributors into their teams. +This includes creating Fedora Badge requests, reviewing guidelines, and making Fedora services and tools more understandable. + +Examples of sub-project support and on-boarding work: + +* https://pagure.io/fedora-commops/issue/62[Wiki gardening of Fedora Join] +* https://pagure.io/fedora-commops/issue/69[Fedora Modularity onboarding] +* https://pagure.io/fedora-commops/issue/76[Update Onboarding Calendar for GSoC 2016] +* https://pagure.io/fedora-commops/issue/95[Onboarding: DotNet SIG] + + +[[join-commops]] +== Join CommOps + +CommOps always welcomes new contributors. +Whether you are a newcomer or an old-timer, there are ways to get involved. +Join CommOps to: + +* Build your portfolio working on real-world projects +* Gain holistic view of the Fedora Project and learn how the pieces fit together +* Work directly with Fedora Project leadership +* Work with teammates from around the world +* Aspire to the greatness of a superhero + +.Join the CommOps team today +[caption="Join the CommOps team today",link="contribute/join.html"] +image::https://fedoraproject.org/w/uploads/7/72/Happypanda.png[Happy Panda,100] + + +[[toolbox]] +== Toolbox + +The CommOps toolbox explains tools and services often used by the team. +The tools are organized by their purpose and use. + +[[communication-tools]] +=== Communication tools + +These tools are for communicating to others in the Fedora community. + +https://docs.fedoraproject.org/fedora-project/subprojects/mindshare/docs/community-blog.html[Community Blog] (CommBlog):: +https://communityblog.fedoraproject.org/[communityblog.fedoraproject.org] +Centralized blog for contributors to publish news, activities, or calls for help to the rest of the project. +Useful place for getting an inside scoop on "what's happening" in Fedora. + +ircbot.py:: +https://infrastructure.fedoraproject.org/cgit/ansible.git/tree/roles/fedmsg/irc/templates/ircbot.py?id=0279643#n77[Python script] for fedmsg notifications in irc://chat.freenode.net/#fedora-commops[#fedora-commops]. +Relays real-time updates and changes relating to CommOps in our IRC channel. + + +[[metrics-tools]] +=== Metrics tools + +These tools access and use the Fedora messaging bus, **fedmsg**. +With these tools, you can generate metrics, analyze data, and interact with fedmsg. + +annualgrepper:: +https://github.com/fedora-infra/fedora-stats-tools/blob/develop/annualgrepper.py[annualgrepper.py] +Gather raw fedmsg totals on https://fedora-fedmsg.readthedocs.io/en/latest/topics.html[topics] in the last year + +cardsite:: +https://pagure.io/cardsite[pagure.io/cardsite] +Live fedmsg tracker inspired by http://emojitracker.com/[emojitracker] + +daily-briefing:: +https://github.com/fedora-infra/fedora-stats-tools/blob/develop/daily-briefing.py[daily-briefing.py] +Template that takes lists of URLs, generates summary reports of daily Meetbot links and action items (manual now, can be automated!) + +datagrepper:: +https://apps.fedoraproject.org/datagrepper/[apps.fedoraproject.org/datagrepper] +The powerhouse tool to interact with fedmsg. +Using HTTP GET requests, query for historical data from fedmsg. +Examples include events by username, by package, by message source, and more. + +fedmsg:: +http://fedmsg.com[fedmsg.com] +Python package and API that hooks into various Fedora Infrastructure services. +Sends messages from each service to a unified message bus in real-time. +fedmsg drives and powers all the metrics tools we have. + +fedora-stats-tools:: +https://github.com/fedora-infra/fedora-stats-tools[github.com/fedora-infra/fedora-stats-tools] +Multiple statistics tools, data, and slide decks for fedmsg metrics, Year in Reviews, and Fedora event metrics + +feedcloud:: +https://pagure.io/feedcloud[pagure.io/feedcloud] +Takes an RSS feed or list of RSS feeds and generates fancy word-clouds for them + +gsoc-stats:: +https://pagure.io/gsoc-stats[pagure.io/gsoc-stats] +Python tool to generate statistics about Fedora contributors + +longtail:: +https://github.com/fedora-infra/fedora-stats-tools/blob/develop/longtail-analyze.py[longtail-analyze.py] +https://github.com/fedora-infra/fedora-stats-tools/blob/develop/longtail-gather.py[longtail-gather.py] +Measure the ratio of activity per user to approximate burnout + +meetbot-fedmsg-activity:: +https://github.com/fedora-infra/fedora-stats-tools/blob/develop/meetbot-fedmsg-activity.py[meetbot-fedmsg-activity.py] +Jinja2 template that creates links to Meetbot activities + +statscache:: +https://github.com/fedora-infra/statscache[github.com/fedora-infra/statscache] +Daemon to build and keep highly-available fedmsg statistics + +wordcloudbot:: +https://pagure.io/wordcloudbot[pagure.io/wordcloudbot] +Create pretty wordclouds from IRC meeting logs + + +[[other]] +=== Other + +Other tools that don't belong elsewhere fit under here. + +OSAS/rh-events:: +https://github.com/OSAS/rh-events[github.com/OSAS/rh-events] +Data for Red Hat conference and talk attendance. +Useful for plotting events in our own calendar and keeping track of what's happening in the open source community. From 75c1b08464d0604225ba06099eb006a2c978eefe Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Mar 27 2018 17:22:24 +0000 Subject: [PATCH 2/2] Address feedback from @bex in PR #146 --- diff --git a/_topic_map.yml b/_topic_map.yml index bdf388c..868d57a 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -21,7 +21,7 @@ # The ordering of the records in this document determines the ordering of the # topic groups and topics on the main page. --- -Name: Fedora Community Operations (CommOps) +Name: Community Operations (CommOps) Dir: docs Topics: - Name: About CommOps diff --git a/docs/index.adoc b/docs/index.adoc index daf21ee..d2bb5c3 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -4,8 +4,7 @@ include::docs/attributes.adoc[] image::docs/_static/img/commops-logo.png[CommOps logo] -Community Operations (CommOps) addresses community architecture and infrastructure in Fedora. -CommOps provides tools, resources, and utilities for different sub-projects of Fedora to improve effective communication. +Community Operations (CommOps) provides tools, resources, and utilities for different sub-projects of Fedora to improve effective communication. The following areas are examples of where CommOps focuses: * Work closely with https://docs.fedoraproject.org/fedora-project/council/fcaic.html[Fedora Community Action and Impact Coordinator] to prioritize key focus areas @@ -29,7 +28,7 @@ IRC channel:: irc://irc.freenode.net/#fedora-commops[#fedora-commops] on Freenod First time using IRC? Look into https://opensource.com/article/17/5/introducing-riot-IRC[Riot], a free and open source client that connects to various IRC networks. -Riot also keeps you connected to IRC even when you're not at the keyboard. +Riot also keeps you connected to IRC even when you're not connected to the Internet. [[workflow]] @@ -47,7 +46,7 @@ For good beginner tasks, look at the _https://pagure.io/fedora-commops/issues?st [[meetings]] == Meetings -CommOps holda a meeting once a week via IRC to check in our tasks and plan ahead. +CommOps holda a meeting once a week on IRC to check in our tasks and plan ahead. Check the https://apps.fedoraproject.org/calendar/commops/[CommOps calendar] for the current date and time. Past meeting minutes are recorded in [https://meetbot.fedoraproject.org/teams/commops/[Meetbot]. @@ -74,14 +73,14 @@ CommOps focuses on a few key areas, both technical and non-technical. === Culture The Fedora Project builds and ships a Linux distribution, but there is a community behind the technical work and planning. +In Fedora, we have the https://docs.fedoraproject.org/fedora-project/project/fedora-overview.html#what-is-fedora-all-about[Four Foundations] to represent our community culture. The Fedora community represents a set of ethics and values to how we build our distribution. These ethics and values create the culture of the Fedora Project. When working in the community, mindfulness of this culture enriches and supports the different sub-communities inside of Fedora. CommOps builds community infrastructure of support and acceptance for the culture of the Fedora community. -In Fedora, we have the https://docs.fedoraproject.org/fedora-project/project/fedora-overview.html#what-is-fedora-all-about[Four Foundations] to represent our community culture. -The _Friends_ part of the Four Foundations is there for a reason. -The community infrastructure CommOps assists with builds on top of the _Friends_ foundation. +The _Friends_ foundation is there for a reason. +The community infrastructure CommOps assists with, builds on top of the _Friends_ foundation. People enjoy contributing in a community where they feel valued for who they are and what they bring to the community, not just that they are useful. CommOps supports this through some of our tasks relating to culture. @@ -109,15 +108,16 @@ Examples of things we do to help organize and execute Fedora elections: * https://pagure.io/fedora-commops/issue/107[Automated Fedocal reminders to send to all mailing lists for upcoming Elections] * https://pagure.io/fedora-commops/issue/112[Create August 2017 election interview templates for candidates] -=== Messaging and storytelling +=== Storytelling Messaging and storytelling bring the "story" of the Fedora Project to both the contributor and user community. Every year, a https://mattdm.org/fedora/2018devconf/DevConfcz2018Charts.pdf[couple thousand people] work on Fedora. -Messaging is a form of storytelling: we bring the message of what we _as a community_ are doing out to others. +Messaging is a way of sharing our story in multiple formats. +We bring the message of what we _as a community_ are doing out to others. Others include our contributors working in other areas of the project and users interested in what the Fedora community produces. -When we share our message with each other, we are mindful of other work happening in the Fedora community. -Communicating the story of Fedora keeps our contributors marching in step together towards our goals. -Our users better understand the goals and objectives of Fedora and how we plan to get there. +When we share our story with each other, we are aware of other work happening in the Fedora community. +Communicating the story of Fedora keeps our contributors moving together towards our goals. +Good messaging helps our users better understand the goals and objectives of Fedora and how we plan to get there. CommOps supports messaging by working with other sub-projects and teams to tell their own stories. CommOps provides the help to "dig out" the stories and the tools to share them widely. @@ -181,7 +181,7 @@ Join CommOps to: * Aspire to the greatness of a superhero .Join the CommOps team today -[caption="Join the CommOps team today",link="contribute/join.html"] +[link="contribute/join.html"] image::https://fedoraproject.org/w/uploads/7/72/Happypanda.png[Happy Panda,100]