Skip to content

Commit b2c7446

Browse files
pedroerpfacebook-github-bot
authored andcommitted
Updates to README file (facebookincubator#11349)
Summary: Pull Request resolved: facebookincubator#11349 Some updates to the README file to reflect out current messaging and make it read more natural. Also pulling the community sections up. Reviewed By: xiaoxmeng, amitkdutta, bikramSingh91 Differential Revision: D64944089 fbshipit-source-id: 5ac64b8ce20cb09ce2f91d33acfeae64e7686cbc
1 parent 817fa90 commit b2c7446

File tree

3 files changed

+71
-58
lines changed

3 files changed

+71
-58
lines changed

CONTRIBUTING.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@ you are expected to uphold this code.
1717
## Community
1818

1919
A good first step to getting involved in the Velox project is to participate in
20-
conversations in GitHub [Issues](https://github.com/facebookincubator/velox/issues)
21-
and [Discussions](https://github.com/facebookincubator/velox/discussions), and join the
22-
[the Velox-OSS Slack workspace](http://velox-oss.slack.com) - please reach out to
23-
**velox@meta.com** to get access.
20+
conversations in GitHub
21+
[Issues](https://github.com/facebookincubator/velox/issues) and
22+
[Discussions](https://github.com/facebookincubator/velox/discussions), and join
23+
the [the Velox-OSS Slack workspace](http://velox-oss.slack.com) - please
24+
comment on [this
25+
Discussion](https://github.com/facebookincubator/velox/discussions/11348) to
26+
get access.
2427

2528
## Components and Maintainers
2629

@@ -56,10 +59,11 @@ maintainers, allowing them to provide more timely feedback and keeping the
5659
amount of rework from contributors to a minimum.
5760

5861
We encourage new contributors to start with bug fixes and small features so you
59-
get familiar with the contributing process, while building relationships with
60-
community members.
61-
Look for GitHub issues labeled [good first issue](https://github.com/facebookincubator/velox/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or consider adding one of the
62-
[missing Presto SQL functions](https://github.com/facebookincubator/velox/issues/2262).
62+
get familiar with the contribution process, while building relationships with
63+
community members. Look for GitHub issues labeled [good first
64+
issue](https://github.com/facebookincubator/velox/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
65+
or consider adding one of the [missing Presto SQL
66+
functions](https://github.com/facebookincubator/velox/issues/2262).
6367

6468
The contribution process is outlined below:
6569

@@ -76,7 +80,7 @@ The contribution process is outlined below:
7680
* Will the change conflict with another change in progress? If so, work with others to minimize impact.
7781

7882
4. Implement the change.
79-
* Always follow the coding best practices outlined in the list below.
83+
* Always follow the [coding best practices](#coding-best-practices) outlined below.
8084
* If the change is large, consider posting a draft Github pull request (PR)
8185
with the title prefixed with [WIP], and share with collaborators to get early feedback.
8286
* Give the PR a clear, brief description; when the PR is
@@ -88,9 +92,9 @@ The contribution process is outlined below:
8892
* Create/submit a Github PR and tag the reviewers identified in Step 3.
8993

9094
5. Review is performed by one or more reviewers.
91-
* This normally happens within a few days, but may take longer if the change is
92-
large, complex, or if a critical reviewer is unavailable (feel free to ping in the
93-
PR).
95+
* This normally happens within a few days, but may take longer if the change
96+
is large, complex, or if a critical reviewer is unavailable (feel free to
97+
ping them in the PR or on Slack).
9498

9599
6. Address feedback and update the PR.
96100
* After pushing changes, add a comment to the PR mentioning the
@@ -102,7 +106,7 @@ The contribution process is outlined below:
102106
addressed and resolve the conversation.
103107

104108
7. Iterate on this process until your changes are reviewed and accepted by a
105-
maintainer. At this point, a Meta employee will be required to merge your PR,
109+
maintainer. At this point, a Meta employee will be notified to merge your PR,
106110
due to tooling limitations.
107111

108112
## Coding Best Practices

README.md

+53-44
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
<img src="static/logo.svg" alt="Velox logo" width="50%" align="center" />
22

3-
Velox is a C++ database acceleration library which provides reusable,
4-
extensible, and high-performance data processing components. These components
5-
can be reused to build compute engines focused on different analytical
6-
workloads, including batch, interactive, stream processing, and AI/ML.
7-
Velox was created by Meta and it is currently developed in partnership with
8-
IBM/Ahana, Intel, Voltron Data, Microsoft, ByteDance and many other companies.
3+
Velox is a composable execution engine distributed as an open source C++
4+
library. It provides reusable, extensible, and high-performance data processing
5+
components that can be (re-)used to build data management systems focused on
6+
different analytical workloads, including batch, interactive, stream
7+
processing, and AI/ML. Velox was created by Meta and it is currently developed
8+
in partnership with IBM/Ahana, Intel, Voltron Data, Microsoft, ByteDance and
9+
many other companies.
910

1011
In common usage scenarios, Velox takes a fully optimized query plan as input
1112
and performs the described computation. Considering Velox does not provide a
@@ -16,25 +17,25 @@ integrating and optimizing their compute engines.
1617
Velox provides the following high-level components:
1718

1819
* **Type**: a generic typing system that supports scalar, complex, and nested
19-
types, such as structs, maps, arrays, tensors, etc.
20+
types, such as structs, maps, arrays, etc.
2021
* **Vector**: an [Arrow-compatible columnar memory layout
2122
module](https://facebookincubator.github.io/velox/develop/vectors.html),
22-
which provides multiple encodings, such as Flat, Dictionary, Constant,
23-
Sequence/RLE, and Bias, in addition to a lazy materialization pattern and
24-
support for out-of-order writes.
23+
providing encodings such as Flat, Dictionary, Constant, and Sequence/RLE, in
24+
addition to a lazy materialization pattern and support for out-of-order
25+
writes.
2526
* **Expression Eval**: a [fully vectorized expression evaluation
2627
engine](https://facebookincubator.github.io/velox/develop/expression-evaluation.html)
2728
that allows expressions to be efficiently executed on top of Vector/Arrow
2829
encoded data.
29-
* **Function Packages**: sets of vectorized function implementations following
30-
the Presto and Spark semantic.
31-
* **Operators**: implementation of common data processing operators such as
32-
scans, projection, filtering, groupBy, orderBy, shuffle, [hash
33-
join](https://facebookincubator.github.io/velox/develop/joins.html), unnest,
34-
and more.
35-
* **I/O**: a generic connector interface that allows different file formats
36-
(ORC/DWRF and Parquet) and storage adapters (S3, HDFS, local files) to be
37-
used.
30+
* **Functions**: sets of vectorized scalar, aggregates, and window functions
31+
implementations following the Presto and Spark semantic.
32+
* **Operators**: implementation of relational operators such as scans, writes,
33+
projections, filtering, grouping, ordering, shuffle/exchange, [hash, merge,
34+
and nested loop joins](https://facebookincubator.github.io/velox/develop/joins.html),
35+
unnest, and more.
36+
* **I/O**: a connector interface for extensible data sources and sinks,
37+
supporting different file formats (ORC/DWRF, Parquet, Nimble), and storage
38+
adapters (S3, HDFS, GCS, ABFS, local files) to be used.
3839
* **Network Serializers**: an interface where different wire protocols can be
3940
implemented, used for network communication, supporting
4041
[PrestoPage](https://prestodb.io/docs/current/develop/serialized-page.html)
@@ -51,10 +52,11 @@ specializations, including:
5152
1. Custom types
5253
2. [Simple and vectorized functions](https://facebookincubator.github.io/velox/develop/scalar-functions.html)
5354
3. [Aggregate functions](https://facebookincubator.github.io/velox/develop/aggregate-functions.html)
54-
4. Operators
55-
5. File formats
56-
6. Storage adapters
57-
7. Network serializers
55+
4. Window functions
56+
5. Operators
57+
6. File formats
58+
7. Storage adapters
59+
8. Network serializers
5860

5961
## Examples
6062

@@ -68,6 +70,34 @@ of available functions [can be found here.](https://facebookincubator.github.io/
6870

6971
Blog posts are available [here](https://velox-lib.io/blog).
7072

73+
## Community
74+
75+
Velox is an open source project supported by a community of individual
76+
contributors and organizations. The project's technical governance mechanics is
77+
described [in this
78+
document.](https://velox-lib.io/docs/community/technical-governance).
79+
80+
Project maintainers [are listed
81+
here](https://velox-lib.io/docs/community/components-and-maintainers).
82+
83+
The main communication channel with the Velox OSS community is through the [the
84+
Velox-OSS Slack workspace](http://velox-oss.slack.com), github Issues, and
85+
Discussions.
86+
87+
For access to the Velox Slack workspace, please add a comment [to this
88+
Discussion](https://github.com/facebookincubator/velox/discussions/11348)
89+
90+
## Contributing
91+
92+
Check our [contributing guide](CONTRIBUTING.md) to learn about how to
93+
contribute to the project.
94+
95+
## License
96+
97+
Velox is licensed under the Apache 2.0 License. A copy of the license
98+
[can be found here.](LICENSE)
99+
100+
71101
## Getting Started
72102

73103
### Get the Velox Source
@@ -201,24 +231,3 @@ you can override the `NUM_THREADS` environment variable by doing:
201231
```shell
202232
$ docker-compose run -e NUM_THREADS=<NUM_THREADS_TO_USE> --rm ubuntu-cpp
203233
```
204-
205-
## Contributing
206-
207-
Check our [contributing guide](CONTRIBUTING.md) to learn about how to
208-
contribute to the project.
209-
210-
## Community
211-
212-
Velox's technical governance mechanics is described [in this
213-
document.](https://velox-lib.io/docs/community/technical-governance).
214-
Components and maintainers [are listed
215-
here](https://velox-lib.io/docs/community/components-and-maintainers).
216-
217-
The main communication channel with the Velox OSS community is through the
218-
[the Velox-OSS Slack workspace](http://velox-oss.slack.com).
219-
Please reach out to **velox@meta.com** to get access to Velox Slack Channel.
220-
221-
## License
222-
223-
Velox is licensed under the Apache 2.0 License. A copy of the license
224-
[can be found here.](LICENSE)

website/docs/community/03-components-and-maintainers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ knowledge. All individuals listed in this page are expected to uphold
1818

1919
## Project Leadership Council - PLC
2020

21-
The PLC is reponsible for the long-term directional leadership of the project:
21+
The PLC is responsible for the long-term directional leadership of the project:
2222

2323
* Masha Basmanova - [mbasmanova](https://github.com/mbasmanova) / mbasmanova@meta.com - **Chair**
2424
* Orri Erling - [oerling](https://github.com/oerling) / oerling@meta.com

0 commit comments

Comments
 (0)