Skip to content

Commit 650065b

Browse files
committed
Some typos and clarifications
1 parent 2258616 commit 650065b

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

docs/about/contact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you have any issues with any of the particular Bullet sub-components, feel fr
1414

1515
## Mailing Lists
1616

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.
17+
If you have a general question, comment, or observation meant for general visibility, reach out to the Users list. If you want to keep it to just the developers, reach to that list instead.
1818

1919
| | Mail | Forum |
2020
| ---------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |

docs/about/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Contributing
22

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!
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 Us page](contact.md) and let us know!
44

55
## Contributor License Agreement (CLA)
66

77
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.
88

99
## Future plans
1010

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!
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 prioritize/approach/break them down. They will be updated as they are solidified. Feel free to [contact us](contact.md) with any ideas/suggestions/PRs!
1212

1313
This list is neither comprehensive nor in any particular order.
1414

docs/quick-start.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ By the following the steps in this section, you will:
1616

1717
## Setting up Storm
1818

19-
To set up a clean working environment, let's start with setting some directories.
19+
To set up a clean working environment, let's start with creating some directories.
2020

2121
#### Step 1: Setup directories and examples
2222

@@ -84,7 +84,7 @@ storm kill topology
8484

8585
!!! note "Local mode cleanup"
8686

87-
If you notice any problems while setting up storm or while relaunching a topology, it may be because some state is corrupted. When running Storm in this fashion, states and serializations are stored in ```storm-local```. You may want to ```rm -rf storm-local/*``` to remove everything in this directory before relaunching Storm components.
87+
If you notice any problems while setting up storm or while relaunching a topology, it may be because some state is corrupted. When running Storm in this fashion, states and serializations are stored in ```storm-local``` and ```/tmp/```. You may want to ```rm -rf storm-local/* /tmp/dev-storm-zookeeper``` to clean up this state before relaunching Storm components. See the [tear down section](#teardown) on how to kill any running instances.
8888

8989
## Setting up the example Bullet topology
9090

@@ -214,15 +214,15 @@ To cleanup all the components we bought up:
214214
| Web Service | ```ps aux | grep [e]xample_context.properties | awk '{print $2}' | xargs kill``` |
215215
| Storm | ```ps aux | grep [a]pache-storm-1.0.3 | awk '{print $2}' | xargs kill``` |
216216

217-
You can also ```rm -rf $BULLET_HOME /tmp/dev-storm-zookeeper /tmp/jetty-*``` to clean up your file system too.
217+
You can also ```rm -rf $BULLET_HOME /tmp/dev-storm-zookeeper /tmp/jetty-*``` to delete *everything* that we did so far.
218218

219219
## What did we do?
220220

221-
This section will cover the various custom pieces this example plugged into Bullet, so you can better understand what we did.
221+
This section will go over the various custom pieces this example plugged into Bullet, so you can better understand what we did.
222222

223223
### Storm topology
224224

225-
The topology was the Bullet topology plugged in with a custom spout. This spout is implemented in this [example project](https://github.com/yahoo/bullet-docs/blob/master/examples/storm/) was already built for you when you [downloaded the examples](#step-1-setup-directories-and-examples). This spout produces a maximum number of records in a given period. Both these arguments are configurable. If you examine $BULLET_HOME/backend/storm/launch.sh, you'll see the following:
225+
The topology was the Bullet topology plugged in with a custom spout. This spout is implemented in this [example project](https://github.com/yahoo/bullet-docs/blob/master/examples/storm/) and was already built for you when you [downloaded the examples](#step-1-setup-directories-and-examples). It does not read from any data source and just produces random, structured data. It also produces only up to a maximum number of records in a given period. Both this maximum and the length of a period are configurable. If you examine $BULLET_HOME/backend/storm/launch.sh, you'll see the following:
226226

227227
```bash
228228
storm jar bullet-storm-example-1.0-SNAPSHOT-jar-with-dependencies.jar \

docs/ui/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,9 @@ In this example, we group by ```tuple_number```. Recall that this is the number
158158
!!! note "Why no Count Distinct after Grouping"
159159

160160
At this time, we do not support counting distinct values per field because with the current implementation of Grouping, it would involve storing Data Sketches within Data Sketches. We are considering this in a future release however.
161+
162+
!!! note "Aha, sorting by tuple_number didn't sort properly!"
163+
164+
Good job, eagle eyes! Unfortunately, whenever we group on fields, those fields become strings under the current implementation. Rather than convert them back at the end, we have currently decided to leave it as is. This means that in your results, if you try and sort by a grouped field, it will perform a lexicographical sort.
165+
166+
This also means that you can actually group by any field - including non primitives such as maps and lists! The field will be converted to a string and that string will be used as the field's representation for uniqueness and grouping purposes.

0 commit comments

Comments
 (0)