Difference between revisions of "Newcomers"

From OpenZFS
Jump to: navigation, search
(Created page with "/---------- Intro --------------- sara /--------- Resources ---------- - contact people responsible - serapheim - contact channels - sara - Section: What's easiest way to g...")
 
(added Windows links)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
/---------- Intro ---------------
 
  
sara
+
== Welcome ==
  
/--------- Resources ----------
+
OpenZFS brings together developers and users from various open-source forks of the original ZFS on different platforms and we're always looking to grow our community.
 +
There are a multitude of ways to contribute to the project and contributors are happy to help newcomers. As we add diverse perspectives, our community becomes richer, and
 +
we're committed to creating an environment where all people feel welcome.
  
- contact people responsible - serapheim
+
== Code of Conduct ==
- contact channels - sara
+
OpenZFS has a Code of Conduct. Before you start participating in the community, please review the [[Code of Conduct]].
- Section: What's easiest way to get started -> Documentation+Wiki, ZoL Get Started + userspace changes, kernel bugs - serapheim
+
 
- table with intro dev resources and point to the other resources wikipage -sara
+
== Newcomer Resources ==
- experts link - serapheim
+
 
- General events happening year round -sara
+
=== Where can I learn more about OpenZFS? ===
 +
 
 +
Here are some introductory resources. For more details about specific parts of ZFS look at the [[Developer_resources |  developer resources page]]
 +
{| class="wikitable"
 +
|-
 +
|[https://www.youtube.com/watch?v=MsY-BafQgj4 OpenZFS Basics] || Matt Ahrens and George Wilson || May 2018
 +
|-
 +
|[https://www.youtube.com/watch?v=ptY6-K78McY Lecture on ZFS Read/Write Code Paths ] || Matt Ahrens || March 2016
 +
|-
 +
|[https://www.youtube.com/watch?v=uJGkyMxdNFE&t=1282s OpenZFS Novel Algorithms] || Matt Ahrens || March 2017
 +
|-
 +
|}
 +
 
 +
=== I have a question! ===
 +
 
 +
We look forward to hearing it! The best way to reach us with questions is by joining our Slack channel #openzfs in [https://openzfs.slack.com OpenZFS@Slack].
 +
 
 +
You can also find people on IRC (#openzfs on Freenode), or the [[https://openzfs.topicbox.com/groups/developer/discussions developer@open-zfs.org mailing list]].
 +
 
 +
=== I'd like to stay informed about events and new features! ===
 +
 
 +
Then you should follow us on Twitter [https://twitter.com/OpenZFS @OpenZFS] . This is our main channel for sharing community updates and promotions of ZFS-related events, blogposts, and talks.
 +
 
 +
The main OpenZFS-specific events that have been taking place consistently for the past few years are:
 +
* The [[OpenZFS_Developer_Summit_2018 | OpenZFS Developer Summit]]
 +
* The [https://zfs.datto.com/ ZFS User Conference]
 +
 
 +
That said, OpenZFS related talks have been popping up in other conferences. For a full list of present, future, and past events and talks see [[Events]] .
 +
 
 +
=== I'd like to contribute! ===
 +
 
 +
That's great! We are always looking to grow our community!
 +
 
 +
If you would like to submit a bug or just search for a bug to tackle, below is the list of the code repositories and bug lists for each platform supporting OpenZFS:
 +
{| class="wikitable"
 +
| '''illumos'''
 +
|[http://wiki.illumos.org/display/illumos/ZFS Webpage]
 +
|[https://github.com/illumos/illumos-gate/ Source]
 +
|[https://www.illumos.org/issues Issues]
 +
|-
 +
| '''FreeBSD'''
 +
|[https://wiki.freebsd.org/ZFS Webpage]
 +
|[https://github.com/freebsd/freebsd/ Source]
 +
|[https://bugs.freebsd.org/bugzilla/ Issues]
 +
|-
 +
| '''ZFS on Linux (ZoL)'''
 +
|[http://zfsonlinux.org/ Webpage]
 +
|[https://github.com/zfsonlinux/zfs/ Source]
 +
|[https://github.com/zfsonlinux/zfs/issues Issues]
 +
|-
 +
| '''ZFS-OSX'''
 +
|[https://openzfsonosx.org/ Webpage]
 +
|[https://github.com/openzfsonosx/zfs Source]
 +
|[https://github.com/openzfsonosx/zfs/issues Issues]
 +
|-
 +
| '''OpenZFS on Windows'''
 +
|[https://openzfsonwindows.org/ Webpage]
 +
|[https://github.com/openzfsonwindows/ GitHub]
 +
|[https://github.com/openzfsonwindows/ZFSin/issues GitHub]
 +
|}
 +
 
 +
If you are just looking for a place to start and get your hands dirty, getting ZoL set up quickly on your computer or in a VM is straightforward (see [https://github.com/zfsonlinux/zfs/wiki/Building-ZFS Building ZoL]).
 +
Then you can try tackling one of the bugs in the [https://github.com/zfsonlinux/zfs/labels/bitesize bitesize] labeled buglist.
 +
 
 +
Remember that submitting code in ZFS is not the only way to contribute to the project. Other ways include but are not limited to the following:
 +
* Write high-level utilities and libraries that leverage the power of OpenZFS.
 +
* Write a blogpost or a tutorial for a new feature. We'll do our best to promote it.
 +
* General Wiki and Documentation updates.
 +
* Community (e.g. create meetups or invite OpenZFS experts at events)
 +
 
 +
If you are still not sure where to start or you have more questions, you can see what's going on in our #newcomers Slack channel or ping @sara and @serapheim directly.

Latest revision as of 21:49, 5 November 2019

Welcome

OpenZFS brings together developers and users from various open-source forks of the original ZFS on different platforms and we're always looking to grow our community. There are a multitude of ways to contribute to the project and contributors are happy to help newcomers. As we add diverse perspectives, our community becomes richer, and we're committed to creating an environment where all people feel welcome.

Code of Conduct

OpenZFS has a Code of Conduct. Before you start participating in the community, please review the Code of Conduct.

Newcomer Resources

Where can I learn more about OpenZFS?

Here are some introductory resources. For more details about specific parts of ZFS look at the developer resources page

OpenZFS Basics Matt Ahrens and George Wilson May 2018
Lecture on ZFS Read/Write Code Paths Matt Ahrens March 2016
OpenZFS Novel Algorithms Matt Ahrens March 2017

I have a question!

We look forward to hearing it! The best way to reach us with questions is by joining our Slack channel #openzfs in OpenZFS@Slack.

You can also find people on IRC (#openzfs on Freenode), or the [developer@open-zfs.org mailing list].

I'd like to stay informed about events and new features!

Then you should follow us on Twitter @OpenZFS . This is our main channel for sharing community updates and promotions of ZFS-related events, blogposts, and talks.

The main OpenZFS-specific events that have been taking place consistently for the past few years are:

That said, OpenZFS related talks have been popping up in other conferences. For a full list of present, future, and past events and talks see Events .

I'd like to contribute!

That's great! We are always looking to grow our community!

If you would like to submit a bug or just search for a bug to tackle, below is the list of the code repositories and bug lists for each platform supporting OpenZFS:

illumos Webpage Source Issues
FreeBSD Webpage Source Issues
ZFS on Linux (ZoL) Webpage Source Issues
ZFS-OSX Webpage Source Issues
OpenZFS on Windows Webpage GitHub GitHub

If you are just looking for a place to start and get your hands dirty, getting ZoL set up quickly on your computer or in a VM is straightforward (see Building ZoL). Then you can try tackling one of the bugs in the bitesize labeled buglist.

Remember that submitting code in ZFS is not the only way to contribute to the project. Other ways include but are not limited to the following:

  • Write high-level utilities and libraries that leverage the power of OpenZFS.
  • Write a blogpost or a tutorial for a new feature. We'll do our best to promote it.
  • General Wiki and Documentation updates.
  • Community (e.g. create meetups or invite OpenZFS experts at events)

If you are still not sure where to start or you have more questions, you can see what's going on in our #newcomers Slack channel or ping @sara and @serapheim directly.