Skip to content

Commit c880183

Browse files
fdegiroleg-nenashev
fdegir
and
oleg-nenashev
authored
Take first stab on TOC Onboarding Document (#151)
* Take first stab on TOC Onboarding Document * Update docs/onboarding.md Co-authored-by: Oleg Nenashev <[email protected]> * Update onboarding.md Co-authored-by: Oleg Nenashev <[email protected]>
1 parent 1714c15 commit c880183

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ The community also uses [Slack for additional collaboration opportunities](https
6868

6969
## Documents
7070
* [Principles](PRINCIPLES.md)
71+
* [Onboarding](docs/onboarding.md)
7172
* [TOC Roadmap](https://github.com/cdfoundation/toc/projects/7)
7273
* [Project Lifecycle](PROJECT_LIFECYCLE.md)
7374
* [Code of Conduct](https://github.com/cdfoundation/.github/blob/main/CODE_OF_CONDUCT.md)

‎docs/onboarding.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# TOC Onboarding
2+
3+
## Quick links
4+
5+
- [TOC Onboarding](#toc-onboarding)
6+
- [Quick links](#quick-links)
7+
- [Introduction](#introduction)
8+
- [Setting Things Up](#setting-things-up)
9+
- [Contributing](#contributing)
10+
- [Communication](#communication)
11+
- [Meetings](#meetings)
12+
- [Recommended Reading](#recommended-reading)
13+
- [Tips and Tricks](#tips-and-tricks)
14+
- [Start Contributing](#start-contributing))
15+
16+
# Introduction
17+
18+
As documented on the [charter](https://github.com/cdfoundation/charter/blob/master/CHARTER.md#7-technical-oversight-committee-toc), the role of the CDF TOC is to facilitate communication and collaboration among the Technical Projects.
19+
The voting members of the TOC consists of nine members and voting members of the TOC will be elected or appointed, as applicable, to such positions.
20+
21+
Additionally, community members can contribute to CDF TOC as [TOC Contributors](https://github.com/cdfoundation/toc/blob/master/CONTRIBUTING.md#toc-contributors).
22+
23+
This document provides few steps that are required by TOC Voting Members and TOC Contributors to follow in order to contribute to the TOC and ease their onboarding experience.
24+
25+
# Setting Things Up
26+
27+
## Contributing
28+
29+
### GitHub
30+
31+
CDF repositories, including the TOC repository, is hosted on GitHub under [CDFoundation Organization](https://github.com/cdfoundation).
32+
In order for you to contribute to CDF TOC or any other CDF repository either as a voting member or TOC Contributor, you must have an account on GitHub.
33+
You can create a GitHub account by following [this link](https://github.com/join).
34+
35+
CDF TOC Voting Members will be added to **toc** GitHub Team upon completion of elections.
36+
Similarly, CDF TOC Contributors will be added to **toc-contributors** GitHub Team when a new community members joins as a TOC Contributor.
37+
It is important to make sure your GitHub handles are documented on [TOC Readme](https://github.com/cdfoundation/toc#members) and [TOC Contributors](https://github.com/cdfoundation/toc/blob/master/CONTRIBUTORS.md).
38+
39+
As a CDF TOC Voting Member or CDF TOC Contributor, [CDF TOC repository](https://github.com/cdfoundation/toc) is where you will be spending most of your time so please keep an eye on/star/watch this repo.
40+
41+
### Google Docs
42+
43+
Some groups within CDF such as TOC use Google Docs for collaboration so it is important to have access to documents located on Google Docs.
44+
45+
### HackMD
46+
47+
Some groups within CDF such as SIGs use [HackMD](https://hackmd.io/team/cdfoundation?nav=overview) so it would be beneficial for you to have an account on HackMD to contribute to the documents developed there.
48+
If you would like to join the CDF Team on HackMD, please create an issue in [Foundation repo](https://github.com/cdfoundation/foundation/issues).
49+
50+
You can see the list of documented developed on HackMD using [this link](https://hackmd.io/@cdfoundation/Sy6QIeu3c).
51+
52+
## Communication
53+
54+
CDF Community uses two main mediums for communication, maillist and Slack.
55+
56+
### Maillist
57+
58+
It is important for TOC Voting Members and TOC Contributors to sign up to [cdf-toc maillist](https://lists.cd.foundation/g/cdf-toc) since this maillist is used for discussions, important announcements, meeting calls, and voting.
59+
60+
### Slack
61+
62+
CDF TOC and community at large uses Slack for additional collaboration opportunities.
63+
It is important TOC Voting Members and TOC Contributors to join **#toc** channel on [CDF Slack](https://join.slack.com/t/cdeliveryfdn/shared_invite/zt-nwc0jjd0-G65oEpv5ynFfPD5oOX5Ogg) in order to take part in discussions and reach out to fellow community members.
64+
65+
## Meetings
66+
67+
CDF TOC meets on a bi-weekly basis on Bevy and CDF Meetings are listed on public Google Calendar.
68+
69+
- [CDF Public Calendar](https://calendar.google.com/calendar/embed?src=linuxfoundation.org_mhf0kmgedn67ihni8r129avp24%40group.calendar.google.comh)
70+
- [CDF TOC Chapter on Bevy](https://community.cd.foundation/technical-oversight-committee-toc/)
71+
72+
### Bevy
73+
74+
In order for TOC Voting Members and TOC Contributors to join CDF TOC Meetings, an account on Bevy is required.
75+
You can create an account on CDF Bevy using [this link](https://community.cd.foundation/).
76+
Please make sure to complete your profile, including your fullname, title, and affiliation.
77+
78+
Once you created your account on Bevy, please run a [pre-call test](https://tokbox.com/developer/tools/precall/) to make sure you are all set for your first meeting.
79+
Some community members reported that Bevy might behave strangely if you have multiple cameras.
80+
If you experience issues and have multiple cameras, you might want to try disabling all the cameras except the one you will be using during the meetings that take place on Bevy.
81+
82+
### Meeting Calendar
83+
84+
All CDF Community Meetings are listed on [CDF Public Calendar](https://calendar.google.com/calendar/embed?src=linuxfoundation.org_mhf0kmgedn67ihni8r129avp24%40group.calendar.google.com&ctz=UTC)(Note the timezone which is UTC.)
85+
You can subscribe the calendar if you would like to see community meetings on your calendar of choosing.
86+
87+
### Meeting Agenda and Notes
88+
89+
CDF TOC develops the meeting agenda and takes notes on [this Google Doc](https://docs.google.com/document/d/1uBHar55fTInWF9Li4t0lyG3tTC8BRLU0FfBfsgk_Jrs/edit?ts=5c9580be#heading=h.en8cy6hno0c6) collaboratively.
90+
You can bookmark the document for ease of access.
91+
92+
### LFX
93+
94+
In order to use any LF Managed Service, you must create an account and community profile.
95+
Having account is required for receiving invites to CDF Governing Board Strategy Sessions.
96+
You could learn more about how to create an account on [this link](https://docs.linuxfoundation.org/lfx/sso/create-an-account).
97+
98+
# Recommended Reading
99+
100+
There are various documents that are important and beneficial to read as you are getting ready to contribute to CDF TOC.
101+
102+
* [CDF Charter](https://github.com/cdfoundation/charter/blob/master/CHARTER.md)
103+
* [CDF TOC Readme](https://github.com/cdfoundation/toc#cdf-toc)
104+
* [CDF TOC Principles](https://github.com/cdfoundation/toc/blob/master/PRINCIPLES.md)
105+
* [Project Lifecycle](https://github.com/cdfoundation/toc/blob/master/PROJECT_LIFECYCLE.md)
106+
* [Code of Conduct](https://github.com/cdfoundation/.github/blob/main/CODE_OF_CONDUCT.md)
107+
* [SIGs](https://github.com/cdfoundation/toc/tree/master/sigs)
108+
* [Blog Guidelines](https://github.com/cdfoundation/foundation/blob/master/blog-guidelines.md)
109+
* [Slack Guidelines](https://github.com/cdfoundation/foundation/blob/master/slack-guidelines.md)
110+
111+
Additionally, CDF TOC has a roadmap which can be seen and contributed to from [this link](https://github.com/cdfoundation/toc/projects/7).
112+
113+
# Tips and Tricks
114+
115+
Here are few tips and tricks that would make your TOC onboarding experience better.
116+
117+
* Regularly join TOC Meetings
118+
* Star/watch [CDF TOC Repository](https://github.com/cdfoundation/toc)
119+
* Bookmark
120+
* [CDF TOC Maillist](https://lists.cd.foundation/g/cdf-toc)
121+
* [CDF TOC Meeting Agenda and Notes](https://docs.google.com/document/d/1uBHar55fTInWF9Li4t0lyG3tTC8BRLU0FfBfsgk_Jrs/edit?ts=5c9580be#heading=h.en8cy6hno0c6)
122+
* [CDF Public Calendar](https://calendar.google.com/calendar/embed?src=linuxfoundation.org_mhf0kmgedn67ihni8r129avp24%40group.calendar.google.com&ctz=UTC)
123+
* Don't forget to run a [pre-call test](https://tokbox.com/developer/tools/precall/) on Bevy
124+
* Install Zoom as some groups use Zoom for their meetings
125+
* Explore channels on [CDF Slack](https://join.slack.com/t/cdeliveryfdn/shared_invite/zt-nwc0jjd0-G65oEpv5ynFfPD5oOX5Ogg) and join them
126+
* Explore other repositories hosted under [CDFoundation Organization](https://github.com/cdfoundation) and start/watch the ones you are interested to follow and contribute
127+
* Check out [CDF Projects](https://cd.foundation/projects/)
128+
* Take a look at [CDF Landscape](https://landscape.cd.foundation/) to see CD landscape as well as CDF Participating Organizations
129+
* Say hi to fellow community members and introduce yourself
130+
131+
# Start Contributing
132+
133+
Here are various ways to contribute
134+
135+
* Fix a typo, update an outdated document, add new tip to help others who might face a similar issue as yourself
136+
* Take meeting minutes, contribute topics to the agenda
137+
* Join SIG and project meetings
138+
* Sponsor new SIGs if needed
139+
* Pick an item from CDF TOC Roadmap and contribute to it
140+
* Improve processes and procedures or propose new ones if you find community needs such a process
141+
142+
Welcome and happy contributing!

0 commit comments

Comments
 (0)