Difference between revisions of "Newcomers"

From OpenZFS
Jump to navigation Jump to search
(→‎I have a question!: Added references to IRC and mailing list after someone came into #openzfs frustrated at having to dig around to find something other than Slack)
(https://wiki.freebsd.org/ZFS is explicitly outdated, historic.)
 
(6 intermediate revisions by 2 users not shown)
Line 5: Line 5:
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
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.
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 ==
== Newcomer Resources ==
Line 25: Line 28:
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].
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]].
You can also find people on IRC ([ircs://irc.libera.chat/#openzfs #openzfs] on [https://libera.chat Libera.chat]), 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! ===
=== I'd like to stay informed about events and new features! ===
Line 33: Line 36:
The main OpenZFS-specific events that have been taking place consistently for the past few years are:
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 [[OpenZFS_Developer_Summit_2018 | OpenZFS Developer Summit]]
* The [https://zfs.datto.com/ ZFS User Conference]
* The monthly [https://docs.google.com/a/delphix.com/document/d/1w2jv2XVYFmBVvG1EGf-9A5HBVsjAYoLIFZAnWHhV-BM/edit?usp=docs_web OpenZFS Leadership Meetings]


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]] .  
That said, many other conferences feature OpenZFS related talks.


=== I'd like to contribute! ===
=== I'd like to contribute! ===
Line 43: Line 46:
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:
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"
{| class="wikitable"
| '''OpenZFS on Linux'''
|[http://zfsonlinux.org Webpage]
|[https://github.com/openzfs/zfs/ Source]
|[https://github.com/openzfs/zfs/issues Issues]
|-
| '''ZFS in FreeBSD'''
|[https://docs.freebsd.org/en/books/handbook/zfs/ FreeBSD Handbook: Chapter 20: The Z File System (ZFS)]
|[https://cgit.freebsd.org/src/log/?h=vendor/openzfs/master Source]
|[https://github.com/zfsonfreebsd/ZoF/issues?q=is%3Aissue Issues]
|-
| '''OpenZFS userland and kernel module for FreeBSD'''
|[https://www.freshports.org/sysutils/openzfs/ sysutils/openzfs] and [https://www.freshports.org/sysutils/openzfs-kmod/ sysutils/openzfs-kmod]
|[https://github.com/zfsonfreebsd/ZoF Source]
|[https://bugs.freebsd.org/bugzilla/buglist.cgi?component=Individual%20Port%28s%29&list_id=432795&product=Ports%20%26%20Packages&query_format=advanced&resolution=---&short_desc=sysutils%2Fopenzfs&short_desc_type=allwordssubstr Issues]
|-
| '''illumos'''
| '''illumos'''
|[http://wiki.illumos.org/display/illumos/ZFS Webpage]
|[http://wiki.illumos.org/display/illumos/ZFS Webpage]
Line 48: Line 66:
|[https://www.illumos.org/issues Issues]
|[https://www.illumos.org/issues Issues]
|-
|-
| '''FreeBSD'''
| '''OpenZFS on OSX'''
|[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://openzfsonosx.org/ Webpage]
|[https://github.com/openzfsonosx/zfs Source]
|[https://github.com/openzfsonosx/zfs Source]
|[https://github.com/openzfsonosx/zfs/issues Issues]
|[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]).
If you are just looking for a place to start and get your hands dirty, getting OpenZFS/ZoL set up quickly on your Linux-based 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.
Then you can try tackling one of the bugs in the [https://github.com/zfsonlinux/zfs/labels/bitesize bitesize] labeled buglist.



Latest revision as of 09:29, 25 July 2021

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 Libera.chat), 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, many other conferences feature OpenZFS related talks.

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:

OpenZFS on Linux Webpage Source Issues
ZFS in FreeBSD FreeBSD Handbook: Chapter 20: The Z File System (ZFS) Source Issues
OpenZFS userland and kernel module for FreeBSD sysutils/openzfs and sysutils/openzfs-kmod Source Issues
illumos Webpage Source Issues
OpenZFS on 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 OpenZFS/ZoL set up quickly on your Linux-based 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.