Skip to content

Commit f33244a

Browse files
authored
Improve documentation site to make it easier to find communication on Slack/Discord (#8138)
1 parent 824bb66 commit f33244a

File tree

3 files changed

+28
-42
lines changed

3 files changed

+28
-42
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,19 @@ Here are links to some important information
4040
DataFusion is great for building projects such as domain specific query engines, new database platforms and data pipelines, query languages and more.
4141
It lets you start quickly from a fully working engine, and then customize those features specific to your use. [Click Here](https://arrow.apache.org/datafusion/user-guide/introduction.html#known-users) to see a list known users.
4242

43+
## Contributing to DataFusion
44+
45+
Please see the [developer’s guide] for contributing and [communication] for getting in touch with us.
46+
47+
[developer’s guide]: https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide
48+
[communication]: https://arrow.apache.org/datafusion/contributor-guide/communication.html
49+
4350
## Crate features
4451

52+
This crate has several [features] which can be specified in your `Cargo.toml`.
53+
54+
[features]: https://doc.rust-lang.org/cargo/reference/features.html
55+
4556
Default features:
4657

4758
- `compression`: reading files compressed with `xz2`, `bzip2`, `flate2`, and `zstd`
@@ -65,9 +76,3 @@ Optional features:
6576
## Rust Version Compatibility
6677

6778
This crate is tested with the latest stable version of Rust. We do not currently test against other, older versions of the Rust compiler.
68-
69-
## Contributing to DataFusion
70-
71-
The [developer’s guide] contains information on how to contribute.
72-
73-
[developer’s guide]: https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide

docs/source/contributor-guide/communication.md

Lines changed: 15 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -26,49 +26,29 @@ All participation in the Apache Arrow DataFusion project is governed by the
2626
Apache Software Foundation's [code of
2727
conduct](https://www.apache.org/foundation/policies/conduct.html).
2828

29+
## GitHub
30+
2931
The vast majority of communication occurs in the open on our
30-
[github repository](https://github.com/apache/arrow-datafusion).
32+
[github repository](https://github.com/apache/arrow-datafusion) in the form of tickets, issues, discussions, and Pull Requests.
33+
34+
## Slack and Discord
3135

32-
## Questions?
36+
We use the Slack and Discord platforms for informal discussions and coordination. These are great places to
37+
meet other contributors and get guidance on where to contribute. It is important to note that any technical designs and
38+
decisions are made fully in the open, on GitHub.
3339

34-
### Mailing list
40+
Most of us use the `#arrow-datafusion` and `#arrow-rust` channels in the [ASF Slack workspace](https://s.apache.org/slack-invite) .
41+
Unfortunately, due to spammers, the ASF Slack workspace requires an invitation to join. To get an invitation,
42+
request one in the `Arrow Rust` channel of the [Arrow Rust Discord server](https://discord.gg/Qw5gKqHxUM).
3543

36-
We use arrow.apache.org's `dev@` mailing list for project management, release
37-
coordination and design discussions
44+
## Mailing list
45+
46+
We also use arrow.apache.org's `dev@` mailing list for release coordination and occasional design discussions. Other
47+
than the the release process, most DataFusion mailing list traffic will link to a GitHub issue or PR for discussion.
3848
([subscribe](mailto:[email protected]),
3949
[unsubscribe](mailto:[email protected]),
4050
[archives](https://lists.apache.org/[email protected])).
4151

4252
When emailing the dev list, please make sure to prefix the subject line with a
4353
`[DataFusion]` tag, e.g. `"[DataFusion] New API for remote data sources"`, so
4454
that the appropriate people in the Apache Arrow community notice the message.
45-
46-
### Slack and Discord
47-
48-
We use the official [ASF](https://s.apache.org/slack-invite) Slack workspace
49-
for informal discussions and coordination. This is a great place to meet other
50-
contributors and get guidance on where to contribute. Join us in the
51-
`#arrow-rust` channel.
52-
53-
We also have a backup Arrow Rust Discord
54-
server ([invite link](https://discord.gg/Qw5gKqHxUM)) in case you are not able
55-
to join the Slack workspace. If you need an invite to the Slack workspace, you
56-
can also ask for one in our Discord server.
57-
58-
### Sync up video calls
59-
60-
We have biweekly sync calls every other Thursdays at both 04:00 UTC
61-
and 16:00 UTC (starting September 30, 2021) depending on if there are
62-
items on the agenda to discuss and someone being willing to host.
63-
64-
Please see the [agenda](https://docs.google.com/document/d/1atCVnoff5SR4eM4Lwf2M1BBJTY6g3_HUNR6qswYJW_U/edit)
65-
for the video call link, add topics and to see what others plan to discuss.
66-
67-
The goals of these calls are:
68-
69-
1. Help "put a face to the name" of some of other contributors we are working with
70-
2. Discuss / synchronize on the goals and major initiatives from different stakeholders to identify areas where more alignment is needed
71-
72-
No decisions are made on the call and anything of substance will be discussed on the mailing list or in github issues / google docs.
73-
74-
We will send a summary of all sync ups to the [email protected] mailing list.

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,12 @@ community.
4343

4444
The `example usage`_ section in the user guide and the `datafusion-examples`_ code in the crate contain information on using DataFusion.
4545

46-
The `developer’s guide`_ contains information on how to contribute.
46+
Please see the `developer’s guide`_ for contributing and `communication`_ for getting in touch with us.
4747

4848
.. _example usage: user-guide/example-usage.html
4949
.. _datafusion-examples: https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples
5050
.. _developer’s guide: contributor-guide/index.html#developer-s-guide
51+
.. _communication: contributor-guide/communication.html
5152

5253
.. _toc.links:
5354
.. toctree::

0 commit comments

Comments
 (0)