Fix getting started schema (#15)

block · Oct 31, 2024 · 20ef312 · 20ef312
1 parent aea06d9
commit 20ef312
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 30 deletions.
diff --git 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: [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 }}`

diff --git a/config/site/src/_includes/footer.html b/config/site/src/_includes/footer.html
@@ -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>

diff --git a/config/site/src/_includes/success_stories.html b/config/site/src/_includes/success_stories.html
@@ -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>
@@ -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>
+            <p class="text-sm text-gray-700 dark:text-gray-300">both query & ingestion</p>
+          </div>
         </div>
       </div>
     </div>

diff --git 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**: