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.

Sign up for GitHub

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

Fix schema on getting started page; Extract tagline #15

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Fix schema on getting started page; Extract tagline #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion config/site/src/_config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ github_url: https://github.com/block/elasticgraph
x_url: https://x.com/elasticgraph
x_username: "@ElasticGraph"
support_email: [email protected]
description: ElasticGraph is an open-source framework for indexing, searching, grouping, and aggregating data
tagline: Schema-driven, scalable, cloud-native, batteries-included GraphQL with superpowers.
description: ElasticGraph is an open-source framework for indexing, searching, grouping, and aggregating data.


# Reusable CSS styling for the site, available via the `site.style` variable, ex: `{{ site.style.body }}`
Expand Down
6 changes: 4 additions & 2 deletions config/site/src/_includes/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ <h3 class="text-lg font-bold text-gray-900 dark:text-gray-100 mb-4">
ElasticGraph
</h3>
<p class="text-gray-700 dark:text-gray-300">
ElasticGraph is an open-source framework for indexing, searching,
grouping, and aggregating data. Join our community and contribute on
{{ site.tagline }}
</p>
<p class="text-gray-700 dark:text-gray-300">
Join our community and contribute on
<a href="{{ site.github_url }}" class="{{ site.style.link}}">GitHub</a>.
</p>
</div>
Expand Down
29 changes: 13 additions & 16 deletions config/site/src/_includes/success_stories.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,6 @@ <h3 class="text-3xl font-semibold mb-6">
reports to load.
</p>
<div class="flex flex-col md:flex-row justify-between gap-6">
<!-- Dataset Card -->
<div class="bg-gray-100 dark:bg-gray-700 p-6 rounded-lg md:w-1/3">
<h4 class="text-xl font-bold mb-4">Dataset</h4>
<p
class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mb-2">
~100TB</p>
<p class="text-sm text-gray-700 dark:text-gray-300">of data</p>
<p
class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mt-4">
100's B</p>
<p class="text-sm text-gray-700 dark:text-gray-300">documents</p>
<p
class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mt-4">
&gt; 100's</p>
<p class="text-sm text-gray-700 dark:text-gray-300">of QPS</p>
</div>
<!-- Ingestion Performance Card -->
<div class="bg-gray-100 dark:bg-gray-700 p-6 rounded-lg md:w-1/3">
<h4 class="text-xl font-bold mb-4">Ingestion Latency</h4>
Expand All @@ -59,6 +43,19 @@ <h4 class="text-xl font-bold mb-4">Query Latency</h4>
<p class="text-sm text-gray-700 dark:text-gray-300">p99.99 latency
</p>
</div>
<!-- Dataset Card -->
<div class="bg-gray-100 dark:bg-gray-700 p-6 rounded-lg md:w-1/3">
<h4 class="text-xl font-bold mb-4">Dataset</h4>
<p class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mb-2">
100TB</p>
<p class="text-sm text-gray-700 dark:text-gray-300">indexed data</p>
<p class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mt-4">
&gt; 100B</p>
<p class="text-sm text-gray-700 dark:text-gray-300">indexed documents</p>
<p class="text-3xl font-extrabold text-blue-600 dark:text-blue-400 mt-4">
&gt; 100 QPS</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Instead of putting this as one metric here under dataset, can we put separate QPS metrics under the query card (and call it Query Performance instead of Query Latency) and put the indexing QPS on the ingestion card and call it Ingestion Performance or Indexing Latency?

And then we can put more accurate numbers for them.

  • > 500 QPS for query performance (I just checked, and we regularly go over that in one cluster)
  • > 180K documents per second for ingestion/indexing performance (our last backfill hovered between 180K and 200K documents per second!)

100 documents per second of indexing perf isn't that impressive so it's nice to put more accurate numbers here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also can we add something about availability? e.g. > 99.999% Availability (which is usually our low water mark in a given week...).

<p class="text-sm text-gray-700 dark:text-gray-300">both query & ingestion</p>
</div>
</div>
</div>
</div>
Expand Down
29 changes: 18 additions & 11 deletions config/site/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,24 @@ You can skip this part for now if you want to play with the sample schema. Other
Define your schema in this file. Here's a basic example:

```ruby
module Schema
module Customers
extend ElasticGraph::Schema

type :customer do
field :id, :string
field :name, :string
field :email, :string
end
end
end
ElasticGraph.define_schema do |schema|
schema.json_schema_version 1

schema.object_type "Artist" do |t|
t.field "id", "ID"
t.field "name", "String"
t.field "lifetimeSales", "Int"
t.field "bio", "ArtistBio"

t.field "albums", "[Album!]!" do |f|
f.mapping type: "nested"
end

t.index "artists"
end
end

# ...
```

3. **Update Configuration**:
Expand Down