deploy: stargate/docs@707f56c

stargate · Jul 12, 2023 · b9249bf · b9249bf
1 parent 64c3ff6
commit b9249bf
Show file tree

Hide file tree

Showing 147 changed files with 1,522 additions and 1,302 deletions.
diff --git a/docs/latest/FAQ.html b/docs/latest/FAQ.html
@@ -330,21 +330,21 @@ <h3 class="title"><a href="index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="develop/api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="develop/_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="develop/_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="develop/_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>
@@ -393,13 +393,13 @@ <h2 id="what-should-i-do-if-i-find-a-bug"><a class="anchor" href="#what-should-i
 <ul>
 <li>
 <p>If you&#8217;ve found an issue while using Stargate, please file a bug in the
-<a href="https://github.com/stargate/stargate">Stargate repo</a> and use the bug label.
+<a href="https://github.com/stargate/stargate" target="_blank" rel="noopener">Stargate repo</a> and use the bug label.
 It&#8217;s also helpful to include the full stack trace and the Stargate and database
 version that you are using so that we can efficiently debug.</p>
 </li>
 <li>
 <p>If you&#8217;ve found an issue with the documentation, please file an issue in the
-<a href="https://github.com/stargate/docs">Stargate docs repo</a>. Pull requests are also
+<a href="https://github.com/stargate/docs" target="_blank" rel="noopener">Stargate docs repo</a>. Pull requests are also
 accepted!</p>
 </li>
 </ul>
@@ -412,32 +412,51 @@ <h2 id="why-should-i-use-stargate-when-i-already-have-an-existing-database"><a c
 <div class="paragraph">
 <p>Stargate provides APIs, data types and access methods that bring new capabilities
 to existing databases.
-Currently Stargate adds both REST and GraphQL APIs for CRUD access to data stored
-in Apache Cassandra&#174; and there are many more APIs coming soon.
+Stargate adds REST, Document, and GraphQL APIs for CRUD access to data stored
+in Apache Cassandra&reg;, DataStax Enterprise (DSE), and Astra DB databases.
 Separating compute and storage also has benefits for maximizing resource
 consumption in cloud environments.
-When using Stargate with Cassandra, you can offload the request coordination
-overhead from your storage instances onto Stargate instances
-which has shown latency improvements in preliminary testing (results coming soon).</p>
+When using Stargate with Cassandra, DSE, and Astra DB, you can offload the request coordination
+overhead from your storage instances onto Stargate instances.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="how-can-i-get-involved"><a class="anchor" href="#how-can-i-get-involved"></a><a class="link" href="#how-can-i-get-involved">How can I get involved?</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>To get started building a new API extension, have a look at the existing
-<a href="https://github.com/stargate/stargate/tree/master/restapi">REST API implementation</a>
-or the <a href="https://github.com/stargate/stargate/tree/master/graphqlapi">GraphQL API implementation</a>
-in the Stargate repo first. To get started building a new storage extension,
-check out the
-<a href="https://github.com/stargate/stargate/tree/master/persistence-cassandra-3.11">persistence-cassandra-3.11 implementation</a>.
-Once you have an idea of what you want to build, shoot us a note on the
-<a href="https://github.com/stargate/stargate/discussions">Github discussion page</a> to discuss.</p>
+<p>To get started building a new API extension, have a look at the v2 implementations in the Stargate repo.</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="https://github.com/stargate/stargate/tree/main/apis/sgv2-restapi" target="_blank" rel="noopener">REST API</a></p>
+</li>
+<li>
+<p><a href="https://github.com/stargate/stargate/tree/main/apis/sgv2-docsapi" target="_blank" rel="noopener">Document API</a></p>
+</li>
+<li>
+<p><a href="https://github.com/stargate/stargate/tree/main/apis/sgv2-graphqlapi" target="_blank" rel="noopener">GraphQL API</a></p>
+</li>
+</ul>
 </div>
 <div class="paragraph">
-<p><strong>Note</strong> that the internal APIs are under active development and they are
-likely to change before the first version is released.</p>
+<p>Once you have an idea of what you want to build, shoot us a note on the
+<a href="https://github.com/stargate/stargate/discussions" target="_blank" rel="noopener">Github discussion page</a>, and let&#8217;s talk.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>The Stargate APIs are under active development and they are likely to change.</p>
+</div>
+</td>
+</tr>
+</table>
 </div>
 </div>
 </div>

diff --git a/docs/latest/concepts/concepts.html b/docs/latest/concepts/concepts.html
@@ -330,21 +330,21 @@ <h3 class="title"><a href="../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../develop/api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../develop/_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../develop/_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../develop/_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/core-index.html b/docs/latest/core-index.html
@@ -330,21 +330,21 @@ <h3 class="title"><a href="index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="develop/api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="develop/_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="develop/_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="develop/_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-collection-checking.html b/docs/latest/develop/api-doc/doc-collection-checking.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-collection-creating.html b/docs/latest/develop/api-doc/doc-collection-creating.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-collection-deleting.html b/docs/latest/develop/api-doc/doc-collection-deleting.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-document-decorations.html b/docs/latest/develop/api-doc/doc-document-decorations.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-document-deleting.html b/docs/latest/develop/api-doc/doc-document-deleting.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-document-operators.html b/docs/latest/develop/api-doc/doc-document-operators.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-document-push-pop-array.html b/docs/latest/develop/api-doc/doc-document-push-pop-array.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>

diff --git a/docs/latest/develop/api-doc/doc-document-simple-where.html b/docs/latest/develop/api-doc/doc-document-simple-where.html
@@ -328,21 +328,21 @@ <h3 class="title"><a href="../../index.html">Stargate Documentation</a></h3>
   <li class="nav-item toggler" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item toggler" data-depth="1">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/api.html">API References</a>
+    <a class="nav-link" href="../api.html">API References</a>
     <button class="nav-item-toggle">
       <svg width="14" height="9" viewBox="0 0 14 9" fill="none" xmlns="http://www.w3.org/2000/svg">
         <path d="M1 1L7 7L13 1" stroke="currentColor" stroke-width="2" />
       </svg>
     </button>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/docv2.html">Stargate Document API v2</a>
+    <a class="nav-link" href="../_attachments/docv2.html">Stargate Document API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv2.html">Stargate REST API v2</a>
+    <a class="nav-link" href="../_attachments/restv2.html">Stargate REST API v2</a>
   </li>
   <li class="nav-item" data-depth="2">
-    <a class="nav-link" href="https://stargate.io/docs/latest/develop/attachments/restv1.html">Stargate REST API v1</a>
+    <a class="nav-link" href="../_attachments/restv1.html">Stargate REST API v1</a>
   </li>
 </ul>
   </li>