From 92e2a89b59bad0071a5d77680e660c058a1a862f Mon Sep 17 00:00:00 2001
From: Brian Sigafoos
Date: Thu, 31 Oct 2024 16:57:48 -0400
Subject: [PATCH] Fix getting started schema
---
config/site/src/_config.yaml | 3 +-
config/site/src/_includes/footer.html | 6 ++--
.../site/src/_includes/success_stories.html | 29 +++++++++----------
config/site/src/getting-started.md | 29 ++++++++++++-------
4 files changed, 37 insertions(+), 30 deletions(-)
diff --git a/config/site/src/_config.yaml b/config/site/src/_config.yaml
index bf22e775..a5a68e6f 100644
--- a/config/site/src/_config.yaml
+++ b/config/site/src/_config.yaml
@@ -7,7 +7,8 @@ github_url: https://github.com/block/elasticgraph
x_url: https://x.com/elasticgraph
x_username: "@ElasticGraph"
support_email: elasticgraph@squareup.com
-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 }}`
diff --git a/config/site/src/_includes/footer.html b/config/site/src/_includes/footer.html
index 565b1a41..256749e4 100644
--- a/config/site/src/_includes/footer.html
+++ b/config/site/src/_includes/footer.html
@@ -6,8 +6,10 @@
ElasticGraph
- ElasticGraph is an open-source framework for indexing, searching,
- grouping, and aggregating data. Join our community and contribute on
+ {{ site.tagline }}
+
+
+ Join our community and contribute on
GitHub.
diff --git a/config/site/src/_includes/success_stories.html b/config/site/src/_includes/success_stories.html
index ae12f4f9..fc486cd1 100644
--- a/config/site/src/_includes/success_stories.html
+++ b/config/site/src/_includes/success_stories.html
@@ -17,22 +17,6 @@
reports to load.
-
-
-
Dataset
-
-
of data
-
-
documents
-
-
of QPS
-
Ingestion Latency
@@ -59,6 +43,19 @@
Query Latency
p99.99 latency
+
+
+
Dataset
+
+
indexed data
+
+
indexed documents
+
+
both query & ingestion
+
diff --git a/config/site/src/getting-started.md b/config/site/src/getting-started.md
index 42fb53b5..7180f3ea 100644
--- a/config/site/src/getting-started.md
+++ b/config/site/src/getting-started.md
@@ -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**: