Skip to content

Commit 42e3d30

Browse files
committed
Adding contact and contribution docs
1 parent 69677a1 commit 42e3d30

File tree

4 files changed

+55
-2
lines changed

4 files changed

+55
-2
lines changed

docs/about/contact.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contact Us
2+
3+
## Issues
4+
5+
If you have any issues with any of the particular Bullet sub-components, feel free to create issues.
6+
7+
| | |
8+
| ------------- | ------ |
9+
| Storm | [https://github.com/yahoo/bullet-storm/issues](https://github.com/yahoo/bullet-storm/issues) |
10+
| Web Service | [https://github.com/yahoo/bullet-service/issues](https://github.com/yahoo/bullet-service/issues) |
11+
| UI | [https://github.com/yahoo/bullet-ui/issues](https://github.com/yahoo/bullet-ui/issues) |
12+
| Record | [https://github.com/yahoo/bullet-record/issues](https://github.com/yahoo/bullet-record/issues) |
13+
| Documentation | [https://github.com/yahoo/bullet-docs/issues](https://github.com/yahoo/bullet-docs/issues) |
14+
15+
## Mailing Lists
16+
17+
If you have a general question, reach out to us at the Users list and at Developers if you have a particular question for the developers.
18+
19+
| | |
20+
| ---------- | ------ |
21+
| Users | [bullet-users@googlegroups.com](bullet-users@googlegroups.com) |
22+
| Developers | [bullet-dev@googlegroups.com](bullet-dev@googlegroups.com) |

docs/about/contributing.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
We welcome all contributions! We also welcome all usage experiences, stories, annoyances and whatever else you want to say. Head on over to our [Contact](contact.md) and let us know!
4+
5+
## Contributor License Agreement (CLA)
6+
7+
Bullet is hosted under the [Yahoo Github Organization](https://github.com/yahoo). In order to contribute to any Yahoo project, you will need to submit a CLA. When you submit a Pull Request to any Bullet repository, a CLABot will ask you to sign the CLA if you haven't signed one already.
8+
9+
## Future plans
10+
11+
Here is a list of features we are currently considering/working on. If the Status column is empty, we are still discussing how to approach/break them. They will be updated as they are solidified. Feel free to [contact us](contact.md) with any ideas/suggestions/PRs!
12+
13+
This list is neither comprehensive nor in any particular order.
14+
15+
| Feature | Components | Description | Status |
16+
|------------------- | ----------- | ------------------------- | ------------- |
17+
| TOP K | UI, BE | A TOP K implementation using DataSketches: FrequentItems | In progress |
18+
| DISTRIBUTION | UI, BE | A query to get the distribution/quantiles of a numeric field using DataSketches: Quantiles | In progress |
19+
| Pub-Sub Queue | BE, WS, UI | WS and BE talk through the pub/sub. Bullet Storm uses Storm DRPC for this, which is strictly request-response. This will let us work on other Stream Processors and support incremental updates through WebSockets or SSEs | |
20+
| Incremental updates| BE, WS, UI | Push results back to users as soon as they arrive. Monoidal operations implies additive, so progressive results can be streamed back. Micro-batching and other features come into play | |
21+
| SQL API | BE, WS | WS supports an endpoint that converts a SQL-like query into Bullet queries | |
22+
| LocalForage | UI | Migration to LocalForage to distance ourselves from the relatively small LocalStorage space | [#9](https://github.com/yahoo/bullet-ui/issues/9) |
23+
| UI Packaging | UI | Github releases and building from source are the only two options. Docker or something similar may be more apt | |
24+
| Simple Settings | UI, WS | There are several settings in the UI and WS that are directly tied to the BE. They should be configurable and optimally configurable from one location | |

docs/ui/setup.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,9 @@ To cement all this, if you wanted an instance of the UI in your CI environment,
162162
}
163163
```
164164

165-
Your UI on CI host will POST to http://bullet-ws.development.domain.com:4080/bullet/api/drpc for UI created Bullet queries, GET the schema from http://bullet-ws.development.domain.com:4080/bullet/api/columns, populate an additional link on the Help dropdown pointing to http://data.docs.domain.com and will GET and cache a defaultFilter from http://bullet-ws.development.domain.com:4080/custom-endpoint/api/defaultQuery.
165+
Your UI on your CI environment will:
166+
167+
* POST to ```http://bullet-ws.development.domain.com:4080/bullet/api/drpc``` for UI created Bullet queries
168+
* GET the schema from ```http://bullet-ws.development.domain.com:4080/bullet/api/columns```
169+
* Populate an additional link on the Help dropdown pointing to ```http://data.docs.domain.com```
170+
* GET and cache a defaultFilter from ```http://bullet-ws.development.domain.com:4080/custom-endpoint/api/defaultQuery```

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ pages:
2020
- Setup: ui/setup.md
2121
- Usage: ui/usage.md
2222
- About:
23-
- Releases: about/releases.md
23+
- Past Releases: about/releases.md
24+
- Contributing: about/contributing.md
25+
- Contact Us: about/contact.md
2426

2527
markdown_extensions:
2628
- admonition

0 commit comments

Comments
 (0)