Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some documentation #128

Merged
merged 4 commits into from
Feb 7, 2023
Merged

Add some documentation #128

merged 4 commits into from
Feb 7, 2023

Conversation

cavokz
Copy link
Collaborator

@cavokz cavokz commented Jan 30, 2023

No description provided.

@cavokz cavokz marked this pull request as draft January 30, 2023 16:32
@cavokz cavokz marked this pull request as ready for review February 2, 2023 14:19
@cavokz cavokz marked this pull request as draft February 2, 2023 15:14
@cavokz cavokz marked this pull request as ready for review February 6, 2023 15:11
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/data_model.md Outdated Show resolved Hide resolved
Comment on lines +7 to +11
Think in this way: data generation is a random process, at its root it
just produces a long random string made of 0s and 1s. What you actually
want is to shape the result and channel the randomness so that the
generated data looks sensible in your context and at the same time never
quite the same.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this -- appreciate the first principals level-set here 🙂. The output (data generated) just needs to meet the minimum interface contract defined by the input query, and can and should vary indiscriminately outside of that.

As a further abstraction (which could be an input to Geneve), have you had any thoughts around some sort of input definition spec or anything? This is probably most applicable to the "click through" example mentioned above, but could be useful when needing to generate multiple documents and managing the references and chained dependencies between each (e.g. capturing parent/child relationships, generating sub-documents that are in the correct subnet, etc). Supporting sequences in EQL is a sorta similar situation, albeit still defined and verifiable by the query spec.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh, reading further looks like the Data Model defined below pretty much handles this. 👍 Would be nice to package these up ala Rally Tracks so it's easy to run pre-defined configurations.

Comment on lines +20 to +21
Currently Geneve is packaged only for [Homebrew](https://brew.sh), you
need first to install the Geneve tap
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's really awesome you've got it on Homebrew 🎉 , but would be nice to have local setup/install instructions as well for folks running/testing locally that may want to make changes on the fly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a "Developers guide"! I'll add it.

Copy link
Member

@spong spong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome stuff here in geneve @cavokz! Thank you so much for putting together this documentation -- it does a great job explaining the tooling, its capabilities, and how to get started.

I've left a few nits, and some larger questions around developer experience that might be best suited as a discussion issue, but overall LGTM! 👍

Please let me know if you have any questions, and I'm happy to discuss any additional developer use cases further as well too, just let me know! 🙂

Copy link
Collaborator

@charlie-pichette charlie-pichette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Just a couple nits. 👍🏼

docs/getting_started.md Outdated Show resolved Hide resolved
docs/getting_started.md Outdated Show resolved Hide resolved
Copy link

@stephmilovic stephmilovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for taking the time to document!

@cavokz cavokz merged commit 6be1b27 into elastic:main Feb 7, 2023
@cavokz cavokz deleted the add-some-docs branch February 7, 2023 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants