This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new f33244a646 Improve documentation site to make it easier to find
communication on Slack/Discord (#8138)
f33244a646 is described below
commit f33244a646f97f0355eab3195d4b89eff3b602c2
Author: Andrew Lamb <[email protected]>
AuthorDate: Sun Nov 12 11:12:41 2023 -0500
Improve documentation site to make it easier to find communication on
Slack/Discord (#8138)
---
README.md | 17 +++++----
docs/source/contributor-guide/communication.md | 50 ++++++++------------------
docs/source/index.rst | 3 +-
3 files changed, 28 insertions(+), 42 deletions(-)
diff --git a/README.md b/README.md
index 1997a6f73d..f5ee1d6d80 100644
--- a/README.md
+++ b/README.md
@@ -40,8 +40,19 @@ Here are links to some important information
DataFusion is great for building projects such as domain specific query
engines, new database platforms and data pipelines, query languages and more.
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.
+## Contributing to DataFusion
+
+Please see the [developer’s guide] for contributing and [communication] for
getting in touch with us.
+
+[developer’s guide]:
https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide
+[communication]:
https://arrow.apache.org/datafusion/contributor-guide/communication.html
+
## Crate features
+This crate has several [features] which can be specified in your `Cargo.toml`.
+
+[features]: https://doc.rust-lang.org/cargo/reference/features.html
+
Default features:
- `compression`: reading files compressed with `xz2`, `bzip2`, `flate2`, and
`zstd`
@@ -65,9 +76,3 @@ Optional features:
## Rust Version Compatibility
This crate is tested with the latest stable version of Rust. We do not
currently test against other, older versions of the Rust compiler.
-
-## Contributing to DataFusion
-
-The [developer’s guide] contains information on how to contribute.
-
-[developer’s guide]:
https://arrow.apache.org/datafusion/contributor-guide/index.html#developer-s-guide
diff --git a/docs/source/contributor-guide/communication.md
b/docs/source/contributor-guide/communication.md
index 11e0e4e0f0..8678aa534b 100644
--- a/docs/source/contributor-guide/communication.md
+++ b/docs/source/contributor-guide/communication.md
@@ -26,15 +26,25 @@ All participation in the Apache Arrow DataFusion project is
governed by the
Apache Software Foundation's [code of
conduct](https://www.apache.org/foundation/policies/conduct.html).
+## GitHub
+
The vast majority of communication occurs in the open on our
-[github repository](https://github.com/apache/arrow-datafusion).
+[github repository](https://github.com/apache/arrow-datafusion) in the form of
tickets, issues, discussions, and Pull Requests.
+
+## Slack and Discord
-## Questions?
+We use the Slack and Discord platforms for informal discussions and
coordination. These are great places to
+meet other contributors and get guidance on where to contribute. It is
important to note that any technical designs and
+decisions are made fully in the open, on GitHub.
-### Mailing list
+Most of us use the `#arrow-datafusion` and `#arrow-rust` channels in the [ASF
Slack workspace](https://s.apache.org/slack-invite) .
+Unfortunately, due to spammers, the ASF Slack workspace requires an invitation
to join. To get an invitation,
+request one in the `Arrow Rust` channel of the [Arrow Rust Discord
server](https://discord.gg/Qw5gKqHxUM).
-We use arrow.apache.org's `dev@` mailing list for project management, release
-coordination and design discussions
+## Mailing list
+
+We also use arrow.apache.org's `dev@` mailing list for release coordination
and occasional design discussions. Other
+than the the release process, most DataFusion mailing list traffic will link
to a GitHub issue or PR for discussion.
([subscribe](mailto:[email protected]),
[unsubscribe](mailto:[email protected]),
[archives](https://lists.apache.org/[email protected])).
@@ -42,33 +52,3 @@ coordination and design discussions
When emailing the dev list, please make sure to prefix the subject line with a
`[DataFusion]` tag, e.g. `"[DataFusion] New API for remote data sources"`, so
that the appropriate people in the Apache Arrow community notice the message.
-
-### Slack and Discord
-
-We use the official [ASF](https://s.apache.org/slack-invite) Slack workspace
-for informal discussions and coordination. This is a great place to meet other
-contributors and get guidance on where to contribute. Join us in the
-`#arrow-rust` channel.
-
-We also have a backup Arrow Rust Discord
-server ([invite link](https://discord.gg/Qw5gKqHxUM)) in case you are not able
-to join the Slack workspace. If you need an invite to the Slack workspace, you
-can also ask for one in our Discord server.
-
-### Sync up video calls
-
-We have biweekly sync calls every other Thursdays at both 04:00 UTC
-and 16:00 UTC (starting September 30, 2021) depending on if there are
-items on the agenda to discuss and someone being willing to host.
-
-Please see the
[agenda](https://docs.google.com/document/d/1atCVnoff5SR4eM4Lwf2M1BBJTY6g3_HUNR6qswYJW_U/edit)
-for the video call link, add topics and to see what others plan to discuss.
-
-The goals of these calls are:
-
-1. Help "put a face to the name" of some of other contributors we are working
with
-2. Discuss / synchronize on the goals and major initiatives from different
stakeholders to identify areas where more alignment is needed
-
-No decisions are made on the call and anything of substance will be discussed
on the mailing list or in github issues / google docs.
-
-We will send a summary of all sync ups to the [email protected] mailing
list.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index bb8e2127f1..3853716617 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -43,11 +43,12 @@ community.
The `example usage`_ section in the user guide and the `datafusion-examples`_
code in the crate contain information on using DataFusion.
-The `developer’s guide`_ contains information on how to contribute.
+Please see the `developer’s guide`_ for contributing and `communication`_ for
getting in touch with us.
.. _example usage: user-guide/example-usage.html
.. _datafusion-examples:
https://github.com/apache/arrow-datafusion/tree/master/datafusion-examples
.. _developer’s guide: contributor-guide/index.html#developer-s-guide
+.. _communication: contributor-guide/communication.html
.. _toc.links:
.. toctree::
