Skip to content

Commit d7f7c21

Browse files
authored
docs: Update README and Maintainers Page (#507)
* docs: move maintainers section from readme to maintainers.md * fix: update keywords at readme * fix: restructure sections on readme * fix: change quick links title to resources overview * add header levels * adjust content * fix: update content to reflect on the website instead of repo * fix: update keywords and tags at maintainers.md * feat: add org and community maintainers sections * fix: remove sections as they're included in the new sections * feat: add a note * fix: wordings * feat: add links * fix: breakdown org maintainers responsibilities for format consistency * fix: remove duplicate sentence
1 parent 9a4327c commit d7f7c21

File tree

2 files changed

+122
-141
lines changed

2 files changed

+122
-141
lines changed

docs/README.md

Lines changed: 47 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -3,158 +3,105 @@ id: README
33
title: 'Virtual Coffee Community Building Resources'
44
sidebar_label: 'Introduction'
55
keywords:
6-
- 'coffee table groups'
7-
- 'virtual coffee coffee table groups'
8-
- 'volunteer roles and responsibilities'
96
- 'virtual coffee community'
107
- 'community guides'
118
- 'community documentation'
129
- 'tech community'
1310
- 'online tech community'
1411
- 'community management'
1512
- 'community building'
16-
- 'monthly challenges'
17-
- 'virtual coffee monthly challenges'
18-
- 'lightning talk'
19-
- 'virtual coffee writers'
20-
- 'community writers'
21-
- 'volunteer roles in online community'
22-
- 'responsibilities of online community volunteers'
2313
- 'building a strong community'
2414
- 'guidelines for online community'
25-
- 'writing community documentation'
2615
- 'online community building strategies'
2716
- 'effective community management techniques'
28-
- 'monthly challenges for online communities'
29-
- 'planning online community events'
3017
tags:
3118
- 'introduction'
3219
---
3320

34-
Welcome to Virtual Coffee's community building resources! This repository contains documentation, procedures, and insights into how we manage various aspects of our tech community. Whether you're looking to understand how we do things at Virtual Coffee, volunteer at Virtual Coffee, start your own community or improve an existing one, we hope these resources will be valuable to you.
21+
Welcome to Virtual Coffee's Community Building Resources!
3522

36-
## About Virtual Coffee
37-
38-
Virtual Coffee's mission is to be a welcoming tech community that allows room for growth and mentorship at all levels and to create meaningful opportunities for learning, leadership, and contribution for everyone.
23+
This documentation, along with procedures and insights, helps you understand how Virtual Coffee manages various aspects of the tech community.
3924

40-
We prioritize supporting one another and believe in the power of learning and teaching at every level. To learn more about who we are, visit our [website](https://virtualcoffee.io/about).
25+
You can use these resources to learn about the operations and volunteering at Virtual Coffee, start your own community, or improve an existing one. These resources aim to be valuable to you.
4126

42-
## Maintainers
43-
44-
The Virtual Coffee maintainers work collaboratively to support the community, ensure its smooth operation, and create a positive and engaging environment. Each maintainer brings unique expertise to their role, with responsibilities tailored to meet the diverse needs of our community. Together, we ensure Virtual Coffee thrives as a space for connection, learning, and growth.
27+
## About Virtual Coffee
4528

46-
### Weekly Events Maintainer - Meg Gutshall
29+
Virtual Coffee's mission is to be a welcoming tech community that allows room for growth and mentorship at all levels and to create meaningful opportunities for learning, leadership, and contribution for everyone.
4730

48-
**Description**: The Weekly Events Maintainer is responsible for organizing and managing the rhythm of our bi-weekly coffee sessions and other regular events, keeping the community connected and engaged.
31+
Virtual Coffee prioritizes supporting one another and believes in the power of learning and teaching at every level. To learn more about the community, visit Virtual Coffee [website](https://virtualcoffee.io/about).
4932

50-
**Responsibilities**:
33+
## Community Building Insights
5134

52-
- Coordinate and facilitate bi-weekly coffee sessions.
53-
- Manage logistics for coffee sessions, such as scheduling and communication.
54-
- Monitor and support Coffee Table Groups to foster small-group interactions.
55-
- Ensure consistent community engagement through regular events.
56-
- Track attendance and engagement patterns to guide future planning.
57-
- Provide onboarding support to new members participating in events.
35+
Throughout these resources, you'll find insights into:
5836

59-
### Special Events Maintainer - BekahHW
37+
- Creating welcoming spaces for developers of all levels
38+
- Organizing and managing regular community events
39+
- Creating leadership and volunteer opportunities
40+
- Maintaining community documentation
41+
- Balancing growth with community intimacy
6042

61-
**Description**: The Special Events Maintainer focuses on creating opportunities for learning, sharing, and celebrating through one-off events and monthly initiatives.
43+
## Resources Overview
6244

63-
**Responsibilities**:
45+
These resources are organized into several key areas of community management:
6446

65-
- Organize and host monthly Lunch & Learn sessions.
66-
- Coordinate Lightning Talks and speaker presentations.
67-
- Manage community-wide initiatives like Hacktoberfest.
68-
- Oversee and facilitate monthly challenges.
69-
- Plan and execute special community initiatives.
70-
- Coordinate with guest speakers and presenters for events.
47+
### [Coffees](./coffees/README.md)
7148

72-
### Community Health Maintainer - Kirk
49+
Documentation and references for managing Virtual Coffee's weekly [Coffees](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/what-to-expect-in-virtual-coffee#coffees-virtual-coffee-weekly-zoom-chats).
7350

74-
**Description**: The Community Health Maintainer is dedicated to cultivating a positive, inclusive, and supportive environment for all community members. This role ensures the emotional and relational well-being of the community.
51+
### [Coffee Table Groups](./coffee-table-groups/README.md)
7552

76-
**Responsibilities**:
53+
Documentation and references for managing Virtual Coffee's [Coffee Table Groups](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/coffee-table-groups).
7754

78-
- Monitor community interactions and address negative behavior or conflicts.
79-
- Develop and enforce community guidelines and the code of conduct.
80-
- Collect feedback from members to continuously improve the community experience.
81-
- Work with moderators to resolve community-related issues.
82-
- Design and refine onboarding plans to welcome new members effectively.
55+
### [Monthly Challenges](./monthly-challenges/README.md)
8356

84-
### Technology Support Maintainer - Dan Ott
57+
Documentation and references for managing Virtual Coffee's [Monthly Challenges](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/monthly-challenges).
8558

86-
**Description**: The Technology Support Maintainer ensures that the community’s digital platforms and tools function smoothly and securely, providing the technological backbone for our operations.
59+
### [Lunch & Learns](./lunch-and-learns/README.md)
8760

88-
**Responsibilities**:
61+
Documentation and references for managing Virtual Coffee's [Lunch & Learn](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/lunch-and-learns) events.
8962

90-
- Oversee and maintain the community’s website, communication tools, and other digital platforms.
91-
- Ensure the security and stability of technology resources.
92-
- Research, recommend, and implement new technologies or features to enhance community engagement.
93-
- Provide technical support to community members and maintainers.
94-
- Collaborate with other maintainers to integrate technology into community initiatives.
63+
### [Lightning Talks](./lightning-talks/README.md)
9564

96-
## Quick Links & Team Leads/Coordinators
65+
Documentation and references for managing Virtual Coffee's [Lightning Talks](https://virtualcoffee.io/resources/virtual-coffee-handbook/guides-to-virtual-coffee/lightning-talk) event.
9766

98-
This repository is organized into several key areas of community management:
67+
### Procedures
9968

100-
- **[How to Use This Repo](#how-to-use-this-repo)**
101-
- **[Lunch & Learns](./lunch-and-learns/)**: Docs and reference for managing Lunch & Learn events
102-
- **Coordinator**: Shelley McHardy
103-
- **[Coffees](./coffees)**: Docs and reference for managing weekly Coffees
104-
- **Leads**: Community Maintainers
105-
- **[Lightning Talks](./lightning-talks)**: Docs and reference for helping out with Lightning Talks
106-
- **[Monthly Challenges](./monthly-challenges)**: Docs and reference for managing Monthly Challenges
107-
- **Leads**: Ayu Adiati and Dominic Duffin
108-
- **[Coffee Table Groups](./coffee-table-groups)**: Docs and reference for managing Coffee Table Groups
109-
- **Coordinator**: **Currently Open!**
110-
- **Procedures**: Procedures for various Virtual Coffee tasks
111-
- **[YouTube](./procedures/av/youtube.md)**: Steps for posting to YouTube
112-
- **[Streaming](./procedures/av/streaming.md)**: Steps for streaming from Zoom to YouTube Live
113-
- **[Add a Coffee Table Group](./procedures/new-coffee-table-group/add-coffee-table-group.md)**: Steps for adding a new Coffee Table Group after receiving an application
114-
- **[Documentation Team](./community-roles/team-leads-and-coordinators.md#documentation-team-lead)**
115-
- **Lead**: Ayu
69+
Procedures and step-by-step guides for navigating various initiatives and tasks within the Virtual Coffee community.
11670

117-
## How to Use This Repo
71+
#### [GitHub Discussions](./procedures/github-discussions/vc-discussion-boards.md)
11872

119-
This repo is meant to help facilitate communication and coordination for Virtual Coffee Contributors.
73+
Guide to using Virtual Coffee's GitHub discussion.
12074

121-
1. **Explore**: Browse through the different folders to find areas of interest.
122-
2. **Learn**: Each section contains documentation on how we approach different aspects of community building.
123-
3. **Adapt**: Feel free to use these resources according to our license as inspiration or templates for your own community initiatives.
124-
4. **Contribute**: If you have suggestions or improvements, please see our [Contributing Guide](https://github.com/Virtual-Coffee/VC-Community-Docs/blob/main/CONTRIBUTING.md).
75+
#### [Adding a New Coffee Table Group](./procedures/new-coffee-table-group/add-coffee-table-group.md)
12576

126-
## Community Building Insights
77+
Guide to setting up a new Coffee Table Group.
12778

128-
Throughout this repository, you'll find insights into:
79+
#### [Community Writer](./procedures/community-writers/README.md)
12980

130-
- Creating welcoming spaces for developers of all levels
131-
- Organizing and managing regular community events
132-
- Creating leadership and volunteer opportunities
133-
- Maintaining community documentation
134-
- Balancing growth with community intimacy
81+
Guide for writing and publishing blog posts for Virtual Coffee on [DEV platform](https://dev.to/virtualcoffee).
13582

136-
## Get Involved with Virtual Coffee
83+
#### [Friday Chats](./procedures/x/friday-chat-template.md)
13784

138-
If you're interested in joining Virtual Coffee or learning more about our community:
85+
Guide for posting Friday Chats on Virtual Coffee's [X account](https://x.com/VirtualCoffeeIO).
13986

140-
- Visit our [website](https://virtualcoffee.io)
141-
- Check out our [membership information](https://virtualcoffee.io/join)
142-
- Explore our [public resources for developers](https://virtualcoffee.io/resources)
87+
#### [YouTube Live Streaming](./procedures/av/streaming.md)
14388

144-
## Questions or Feedback?
89+
Guide for live streaming on Virtual Coffee's [YouTube channel](https://www.youtube.com/@VirtualCoffeeIO).
14590

146-
If you have questions about our processes or want to discuss community building, feel free to open an issue or start a [discussion](https://github.com/Virtual-Coffee/VC-Community-Docs/discussions) in this repository. We're always happy to connect!
91+
#### [Posting Videos on YouTube](./procedures/av/youtube.md)
14792

148-
We hope these resources are helpful. Remember, every community is unique, so adapt these ideas to fit your specific needs and values. Happy community building!
93+
Guide for posting videos on Virtual Coffee's YouTube channel.
14994

150-
::::note
95+
## Get Involved with Virtual Coffee
15196

152-
Any changes to this repo need to be via a Pull Request (you can do this on your machine or through the GitHub web interface).
97+
If you're interested in joining Virtual Coffee or learning more about the community:
15398

154-
:::danger[Heads up!]
99+
- Visit Virtual Coffee [website](https://virtualcoffee.io)
100+
- Check out Virtual Coffee [membership information](https://virtualcoffee.io/join)
101+
- Explore Virtual Coffee [public resources for developers](https://virtualcoffee.io/resources)
155102

156-
If you'd like to make a change to this repo's docs, please make sure you've started with an issue (or a discussion board post) first, and that you've been assigned to the issue. This allows the maintainer team to provide guidance and prioritize tasks - otherwise you may run the risk of spending time on something that doesn't end up getting accepted for various reasons. Read our [Contributors' Guide](https://github.com/Virtual-Coffee/VC-Community-Docs/blob/main/CONTRIBUTING.md) for more info.
103+
## Questions or Feedback?
157104

158-
:::
105+
If you have questions about Virtual Coffee processes, want to discuss community building, or have an idea to improve these resources, feel free to [open an issue](https://github.com/Virtual-Coffee/VC-Community-Docs/issues/new/choose) or start a [discussion](https://github.com/Virtual-Coffee/VC-Community-Docs/discussions) in the repository. Always happy to connect!
159106

160-
::::
107+
Remember, every community is unique, so adapt these ideas to fit your specific needs and values. Happy community building!

0 commit comments

Comments
 (0)