Merge pull request #466 from codenotary/chore_update_1.9DOM.1

doc for release v1.9DOM.1

src/.vuepress/enhanceApp.js

@@ -31,6 +31,7 @@ import getSidebarV1_4_0 from './sidebar_v1_4_0'
 import getSidebarV1_4_1 from './sidebar_v1_4_1'
 import getSidebarV1_5_0 from './sidebar_v1_5_0'
 import getSidebarV1_9DOM_0 from './sidebar_v1_9DOM_0'
+import getSidebarV1_9DOM_1 from './sidebar_v1_9DOM_1'
 import getSidebarMaster from './sidebar_master'
 
 const getSidebar = version => {
@@ -64,6 +65,10 @@ const getSidebar = version => {
     return getSidebarV1_9DOM_0(version);
   }
 
+  if (version == '/1.9DOM.1') {
+    return getSidebarV1_9DOM_1(version);
+  }
+
   return getSidebarMaster(version);
 }
 

src/.vuepress/sidebar_v1_9DOM_1.js

@@ -0,0 +1,184 @@
+export default version => {
+  let sidebar = []
+
+  /* WELCOME SECTION START */
+  const introduction = {
+    title: 'Introduction',
+    collapsable: true,
+    sidebarDepth: 1,
+    initialOpenGroupIndex: -1,
+    children: [
+      `${version}/`,
+      `${version}/immudb`,
+      `${version}/playground`,
+    ]
+  };
+  /* WELCOME SECTION END */
+
+  /* RUNNING IMMUDB SECTION START */
+  const runningImmudb = {
+    title: 'Running immudb',
+    collapsable: true,
+    children: [
+    ]
+  };
+
+  runningImmudb.children.push(`${version}/running/download`);
+  runningImmudb.children.push(`${version}/running/service`);
+  runningImmudb.children.push(`${version}/running/build`);
+  runningImmudb.children.push(`${version}/running/configuration`);
+  /* RUNNING IMMUDB SECTION END */
+
+  /* RUNNING SAMPLES SECTION START */
+  const samplesImmudb = {
+    title: 'Running samples',
+    collapsable: true,
+    children: [
+    ]
+  };
+
+  samplesImmudb.children.push(`${version}/samples/go`);
+  /* RUNNING SAMPLES SECTION END */
+
+  /* IMMUDB IN PRODUCTION SECTION START */
+  const immudbInProduction = {
+    title: 'immudb in production',
+    collapsable: true,
+    children: [
+    ]
+  };
+
+  immudbInProduction.children.push(`${version}/production/planning`);
+  immudbInProduction.children.push(`${version}/production/monitoring`);
+  immudbInProduction.children.push(`${version}/production/auditor`);
+  immudbInProduction.children.push(`${version}/production/index-maintenance`);
+  immudbInProduction.children.push(`${version}/production/backup`);
+  immudbInProduction.children.push(`${version}/production/replication`);
+  immudbInProduction.children.push(`${version}/production/sync-replication`);
+  immudbInProduction.children.push(`${version}/production/fips`);
+  immudbInProduction.children.push(`${version}/production/s3-storage`);
+  immudbInProduction.children.push(`${version}/production/backwards-compatibility`);
+  immudbInProduction.children.push(`${version}/production/performance-guide`);
+  immudbInProduction.children.push(`${version}/production/retention`);
+  /* RUNNING IMMUDB IN PRODUCTION SECTION END */
+
+  /* CONNECTING SECTION START */
+  let connecting = {
+      title: 'Connecting with immudb',
+      collapsable: true,
+      children: [
+      ]
+  };
+
+  connecting.children.push(`${version}/connecting/webconsole`);
+  connecting.children.push(`${version}/connecting/clitools`);
+  connecting.children.push(`${version}/connecting/sdks`);
+  connecting.children.push(`${version}/connecting/immugw`);
+  connecting.children.push(`${version}/connecting/authentication`);
+  connecting.children.push(`${version}/connecting/healthcheck`);
+
+  /* CONNECTING SECTION END */
+
+  /* MANAGEMENT SECTION START */
+  const management = {
+    title: 'Management',
+    collapsable: true,
+    children: [
+      `${version}/management/user`,
+      `${version}/management/database`,
+      `${version}/management/state`,
+    ]
+  };
+  /* MANAGEMENT SECTION END */
+
+  /* DEVELOP KV SECTION START */
+  let developKV = {
+      title: 'Develop with Key Value',
+      collapsable: true,
+      children: [
+      ]
+  };
+
+  developKV.children.push(`${version}/develop/reading`);
+  developKV.children.push(`${version}/develop/queries-history`);
+  developKV.children.push(`${version}/develop/indexes`);
+  developKV.children.push(`${version}/develop/transactions`);
+  developKV.children.push(`${version}/develop/deleting`);
+  developKV.children.push(`${version}/develop/expiration`);
+  developKV.children.push(`${version}/develop/streams`);
+
+  /* DEVELOP KV SECTION END */
+
+  /* DEVELOP SQL SECTION START */
+  let developSQL = {
+      title: 'Develop with SQL',
+      collapsable: true,
+      children: [
+      ]
+  };
+
+  developSQL.children.push(`${version}/develop/sql/transactions`);
+  developSQL.children.push(`${version}/develop/sql/datatypes`);
+  developSQL.children.push(`${version}/develop/sql/tablescreate`);
+  developSQL.children.push(`${version}/develop/sql/tablesalter`);
+  developSQL.children.push(`${version}/develop/sql/tablesdrop`);
+  developSQL.children.push(`${version}/develop/sql/insertupdate`);
+  developSQL.children.push(`${version}/develop/sql/indexes`);
+  developSQL.children.push(`${version}/develop/sql/querying`);
+  developSQL.children.push(`${version}/develop/sql/users`);
+  developSQL.children.push(`${version}/develop/sql/catalog`);
+  developSQL.children.push(`${version}/develop/sql/sqlstdlib`);
+  developSQL.children.push(`${version}/develop/sql/pg`);
+
+  /* DEVELOP SQL SECTION END */
+
+  /* DEVELOP DOCUMENT SECTION START */
+  let developDocument = {
+      title: 'Develop with Document',
+      collapsable: true,
+      children: [
+      ]
+  };
+
+  developDocument.children.push(`${version}/develop/document/datamodel`);
+  developDocument.children.push(`${version}/develop/document/api`);
+
+  /* DEVELOP DOCUMENT SECTION END */
+
+  /* EMBEDDED SECTION START */
+  let embedded = {
+    title: 'Embedded',
+    collapsable: true,
+    children: [
+      `${version}/embedded/embedding`,
+      `${version}/embedded/embeddingSQL`,
+    ]
+  };
+  /* EMBEDDED SECTION END */
+
+  /* RELEASE NOTES SECTION START */
+  let releaseNotes = {
+    title: 'Release Notes',
+    collapsable: true,
+    children: [
+    ]
+  };
+
+  releaseNotes.children.push(`${version}/releasenotes`);
+
+  /* RELEASE NOTES SECTION END */
+
+  sidebar.push(introduction);
+  sidebar.push(runningImmudb);
+  sidebar.push(samplesImmudb);
+  sidebar.push(immudbInProduction);
+  sidebar.push(connecting);
+  sidebar.push(management);
+  sidebar.push(developKV);
+  sidebar.push(developSQL);
+  sidebar.push(developDocument);
+  sidebar.push(embedded);
+  sidebar.push(releaseNotes);
+
+  return sidebar;
+}

src/.vuepress/theme/util/index.js

@@ -255,6 +255,7 @@ export const versions = [
   '1.4.1',
   '1.5.0',
   '1.9DOM.0',
+  '1.9DOM.1',
   'master'
 ]
 

src/1.9DOM.0/running/download.md

@@ -6,11 +6,11 @@ To learn interactively and to get started with immudb from the command line and
 
 <WrappedSection>
 
-You may download the immudb binary from [the latest releases on Github](https://github.com/codenotary/immudb/releases/latest). Once you have downloaded immudb, rename it to `immudb`, make sure to mark it as executable, then run it. The following example shows how to obtain v1.5.0 for linux amd64:
+You may download the immudb binary from [the latest releases on Github](https://github.com/codenotary/immudb/releases/latest). Once you have downloaded immudb, rename it to `immudb`, make sure to mark it as executable, then run it. The following example shows how to obtain v1.9DOM.0 for linux amd64:
 
 ```bash
-$ wget https://github.com/vchain-us/immudb/releases/download/v1.5.0/immudb-v1.5.0-linux-amd64
-$ mv immudb-v1.5.0-linux-amd64 immudb
+$ wget https://github.com/vchain-us/immudb/releases/download/v1.9DOM.0/immudb-v1.9DOM.0-linux-amd64
+$ mv immudb-v1.9DOM.0-linux-amd64 immudb
 $ chmod +x immudb
 
 # run immudb in the foreground to see all output

src/1.9DOM.1/README.md

@@ -0,0 +1,26 @@
+# Welcome
+
+<WrappedSection>
+
+<img align="right" src="/logos/immudb-mascot.svg" width="256px"/>
+
+Welcome to the immudb documentation. Great to see you here!
+
+immudb is a database written in Go, but unlike other databases, it is immutable: history is preserved and can't be changed without clients noticing.
+
+immudb can operate as a key-value, relational (SQL) or document database, making it a truly no-SQL database.
+
+immudb can be run as full database server with replicas or easily embedded as a lightweight database into application.
+
+</WrappedSection>
+
+<WrappedSection>
+
+### Help and Support
+Join our [Discord community](https://discord.gg/ThSJxNEHhZ)
+
+  <CnSocialButton social="discord" href="https://discord.gg/ThSJxNEHhZ" target="_blank" rel="external" bottom-offset="15"></CnSocialbutton>
+
+  <CnSocialButton social="twitter" target="_blank" rel="external" href="https://twitter.com/intent/tweet?text=immudb:%20lightweight,%20high-speed%20immutable%20database!&url=https://github.com/codenotary/immudb"></CnSocialButton>
+
+</WrappedSection>