(docs): Improve website structure (#144)

lambdaworks · Apr 3, 2023 · 8cbd1a9 · 8cbd1a9
1 parent 2ed8919
commit 8cbd1a9
Show file tree

Hide file tree

Showing 31 changed files with 176 additions and 19 deletions.
diff --git a/docs/overview/aggregations/elastic_aggregation_terms.md b/docs/overview/aggregations/elastic_aggregation_terms.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_aggregation_terms
+id: elastic_aggregation_terms
 title: "Terms Aggregation"
 ---
 

diff --git a/docs/overview/elastic_aggregation.md b/docs/overview/elastic_aggregation.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_aggregation
+id: elastic_aggregation
 title: "Overview"
 ---
 

diff --git a/docs/overview/elastic_query.md b/docs/overview/elastic_query.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_query
+id: elastic_query
 title: "Overview"
 ---
 

diff --git a/docs/overview/elastic_request.md b/docs/overview/elastic_request.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_request
+id: elastic_request
 title: "Overview"
 ---
 

diff --git a/docs/overview/queries/elastic_query_contains.md b/docs/overview/queries/elastic_query_contains.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_query_contains
+id: elastic_query_contains
 title: "Contains Query"
 ---
 

diff --git a/docs/overview/queries/elastic_query_exists.md b/docs/overview/queries/elastic_query_exists.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_query_exists
+id: elastic_query_exists
 title: "Exists Query"
 ---
 

diff --git a/docs/overview/queries/elastic_query_filter.md b/docs/overview/queries/elastic_query_filter.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_filter
+title: "Filter Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_match_all.md b/docs/overview/queries/elastic_query_match_all.md
@@ -0,0 +1,21 @@
+---
+id: elastic_query_match_all
+title: "Match All Query"
+---
+
+The most simple query, which matches all documents, giving them all a `_score` of `1.0`.
+
+To create a `MatchAll` query do the following:
+
+```scala
+import zio.elasticsearch.query.MatchAllQuery
+import zio.elasticsearch.ElasticQuery._
+
+val query: MatchAllQuery = matchAll
+```
+
+If you want to change the `_score`, you can use the `boost` method:
+
+```scala
+val queryWithBoost: MatchAllQuery = matchAll.boost(1.2)
+```
diff --git a/docs/overview/queries/elastic_query_matches.md b/docs/overview/queries/elastic_query_matches.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_matches
+title: "Matches Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_must.md b/docs/overview/queries/elastic_query_must.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_must
+title: "Must Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_must_not.md b/docs/overview/queries/elastic_query_must_not.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_must_not
+title: "Must Not Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_nested.md b/docs/overview/queries/elastic_query_nested.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_nested
+title: "Nested Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_range.md b/docs/overview/queries/elastic_query_range.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_range
+title: "Range Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_should.md b/docs/overview/queries/elastic_query_should.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_should
+title: "Should Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_starts_with.md b/docs/overview/queries/elastic_query_starts_with.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_starts_with
+title: "Starts With Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_term.md b/docs/overview/queries/elastic_query_term.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_term
+title: "Term Query"
+---
+
+TBD
diff --git a/docs/overview/queries/elastic_query_wildcard.md b/docs/overview/queries/elastic_query_wildcard.md
@@ -0,0 +1,6 @@
+---
+id: elastic_query_wildcard
+title: "Wildcard Query"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_aggregate.md b/docs/overview/requests/elastic_request_aggregate.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_request_aggregate
+id: elastic_request_aggregate
 title: "Aggregation Request"
 ---
 

diff --git a/docs/overview/requests/elastic_request_bulk.md b/docs/overview/requests/elastic_request_bulk.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_request_bulk
+id: elastic_request_bulk
 title: "Bulk Request"
 ---
 

diff --git a/docs/overview/requests/elastic_request_count.md b/docs/overview/requests/elastic_request_count.md
@@ -1,5 +1,5 @@
 ---
-id: overview_elastic_request_count
+id: elastic_request_count
 title: "Count Request"
 ---
 

diff --git a/docs/overview/requests/elastic_request_create.md b/docs/overview/requests/elastic_request_create.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_create
+title: "Create Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_create_index.md b/docs/overview/requests/elastic_request_create_index.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_create_index
+title: "Create Index Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_delete_by_id.md b/docs/overview/requests/elastic_request_delete_by_id.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_delete_by_id
+title: "Delete By ID Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_delete_by_query.md b/docs/overview/requests/elastic_request_delete_by_query.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_delete_by_query
+title: "Delete By Query Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_delete_index.md b/docs/overview/requests/elastic_request_delete_index.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_delete_index
+title: "Delete Index Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_exists.md b/docs/overview/requests/elastic_request_exists.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_exists
+title: "Exists Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_get_by_id.md b/docs/overview/requests/elastic_request_get_by_id.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_get_by_id
+title: "Get By ID Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_search.md b/docs/overview/requests/elastic_request_search.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_search
+title: "Search Request"
+---
+
+TBD
diff --git a/docs/overview/requests/elastic_request_upsert.md b/docs/overview/requests/elastic_request_upsert.md
@@ -0,0 +1,6 @@
+---
+id: elastic_request_upsert
+title: "Upsert Request"
+---
+
+TBD
diff --git a/website/package.json b/website/package.json
@@ -24,7 +24,9 @@
     "react-dom": "^17.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.4.0"
+    "@docusaurus/module-type-aliases": "^2.4.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.3"
   },
   "browserslist": {
     "production": [

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -13,27 +13,47 @@ module.exports = {
                 type: 'category',
                 label: 'Elastic Query',
                 items: [
-                    'overview/overview_elastic_query',
-                    'overview/queries/overview_elastic_query_contains',
-                    'overview/queries/overview_elastic_query_exists',
+                    'overview/elastic_query',
+                    'overview/queries/elastic_query_contains',
+                    'overview/queries/elastic_query_exists',
+                    'overview/queries/elastic_query_filter',
+                    'overview/queries/elastic_query_match_all',
+                    'overview/queries/elastic_query_matches',
+                    'overview/queries/elastic_query_must',
+                    'overview/queries/elastic_query_must_not',
+                    'overview/queries/elastic_query_nested',
+                    'overview/queries/elastic_query_range',
+                    'overview/queries/elastic_query_should',
+                    'overview/queries/elastic_query_starts_with',
+                    'overview/queries/elastic_query_term',
+                    'overview/queries/elastic_query_wildcard',
                 ],
             },
             {
                 type: 'category',
                 label: 'Elastic Aggregation',
                 items: [
-                    'overview/overview_elastic_aggregation',
-                    'overview/aggregations/overview_elastic_aggregation_terms',
+                    'overview/elastic_aggregation',
+                    'overview/aggregations/elastic_aggregation_terms',
                 ],
             },
             {
                 type: 'category',
                 label: 'Elastic Request',
                 items: [
-                    'overview/overview_elastic_request',
-                    'overview/requests/overview_elastic_request_aggregate',
-                    'overview/requests/overview_elastic_request_bulk',
-                    'overview/requests/overview_elastic_request_count',
+                    'overview/elastic_request',
+                    'overview/requests/elastic_request_aggregate',
+                    'overview/requests/elastic_request_bulk',
+                    'overview/requests/elastic_request_count',
+                    'overview/requests/elastic_request_create',
+                    'overview/requests/elastic_request_create_index',
+                    'overview/requests/elastic_request_delete_by_id',
+                    'overview/requests/elastic_request_delete_by_query',
+                    'overview/requests/elastic_request_delete_index',
+                    'overview/requests/elastic_request_exists',
+                    'overview/requests/elastic_request_get_by_id',
+                    'overview/requests/elastic_request_search',
+                    'overview/requests/elastic_request_upsert',
                 ],
             },
             'overview/overview_zio_prelude_schema',