Mfancher/doc updates (#842)

* save * Update Docs
hpcc-systems · Aug 29, 2024 · 17ec3a7 · 17ec3a7
1 parent 9dc4042
commit 17ec3a7
Show file tree

Hide file tree

Showing 11 changed files with 222 additions and 166 deletions.
diff --git a/Tombolo/server/seeders/20190924045211-identitydetails.js b/Tombolo/server/seeders/20190924045211-identitydetails.js
@@ -1,130 +1,137 @@
-'use strict';
-const { v4: uuidv4 } = require('uuid');
+"use strict";
+const { v4: uuidv4 } = require("uuid");
 
 module.exports = {
   up: (queryInterface, Sequelize) => {
-    return queryInterface.bulkInsert('data_types', [{
-      id: uuidv4(),
-      name : 'Drivers License',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Credit Card',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'PHI',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'SSN',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'DOB',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Policy Number',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Zipcode',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Medical Record Number',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'License Number',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'IP Addresses',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Phone Number',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Street Address',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Name',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Passport Number',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Login Details',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Email Address',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Other Unique Identifiers',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },
-    {
-      id: uuidv4(),
-      name : 'Geo Coordinate',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },{
-      id: uuidv4(),
-      name : 'State/Province',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    },{
-      id: uuidv4(),
-      name : 'City',
-      createdAt : new Date(),
-      updatedAt : new Date()
-    }], {});
-
+    return queryInterface.bulkInsert(
+      "data_types",
+      [
+        {
+          id: uuidv4(),
+          name: "Drivers License",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Credit Card",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "PHI",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "SSN",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "DOB",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Policy Number",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Zipcode",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Medical Record Number",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "License Number",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "IP Addresses",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Phone Number",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Street Address",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Name",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Passport Number",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Login Details",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Email Address",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Other Unique Identifiers",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "Geo Coordinate",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "State/Province",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+        {
+          id: uuidv4(),
+          name: "City",
+          createdAt: new Date(),
+          updatedAt: new Date(),
+        },
+      ],
+      {}
+    );
   },
 
   down: (queryInterface, Sequelize) => {
-    return queryInterface.bulkDelete('data_types', null, {});
-  }
+    return queryInterface.bulkDelete("data_types", null, {});
+  },
 };
diff --git a/docs/docs/Developer-Guides/Contribute.md b/docs/docs/Developer-Guides/Contribute.md
diff --git a/docs/docs/Developer-Guides/_category_.json b/docs/docs/Developer-Guides/_category_.json
diff --git a/docs/docs/Developer-Guides/integrations.md b/docs/docs/Developer-Guides/integrations.md
diff --git a/docs/docs/Quick-Start/Installation.md b/docs/docs/Quick-Start/Installation.md
@@ -72,24 +72,30 @@ npm i
 npx sequelize db:migrate
 ```
 
+```bash
+npx sequelize db:seed:all
+```
+
 ```bash
 node server.js
 ```
 
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+The `cd` command changes the directory you're working with.
 
 The `npm i` command installs dependencies located in the package.json file necessary for running and compiling the code.
 
 The `npx sequelize db:migrate` command installs dependencies located in the package.json file necessary for running and compiling the code.
 
+The `npx sequelize db:seed:all` command seeds the database with necessary data for runtime.
+
 The `node server.js` command starts the backend server and associated API's necessary for the front end
 
 ## Start the front end
 
 Open a seperate terminal, and navigate to your installation location
 
 ```bash
-cd client-reactjs
+cd tombolo/client-reactjs
 ```
 
 ```bash
@@ -100,12 +106,12 @@ npm i
 npm start
 ```
 
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+The `cd` command changes the directory you're working with.
 
 The `npm i` command installs dependencies located in the package.json file necessary for running and compiling the code.
 
 The `npm start` command starts your front end development environment at [http://localhost:3000/](http://localhost:3000/)
 
 ## Congratulations
 
-Your Tombolo installation is now up and running. Lets learn some of the core concepts of the software.
+Your Tombolo installation is now up and running. Navigate to [http://localhost:3000/](http://localhost:3000/) to start the new user tutorial. Tombolo has a built in tutorial that will walk you through the final steps to getting your installation up and running.
diff --git a/docs/docs/Quick-Start/application.md → docs/docs/User-Guides/application.md b/docs/docs/Quick-Start/application.md → docs/docs/User-Guides/application.md
diff --git a/docs/docs/User-Guides/assets.md b/docs/docs/User-Guides/assets.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 label: "Assets"
 title: "Assets"
 ---
@@ -28,7 +28,7 @@ project by clicking on the GitHub Projects link in the left navigation bar.
 
 ## Index
 
-For indexes, you can search and add them using the auto-complete search field. A minimum of three characters
+For indeces, you can search and add them using the auto-complete search field. A minimum of three characters
 is required to trigger the search. You can view the payload and workunit related to the imported indexes.
 
 ## Query

diff --git a/docs/docs/Quick-Start/cluster.md → docs/docs/User-Guides/cluster.md b/docs/docs/Quick-Start/cluster.md → docs/docs/User-Guides/cluster.md