tigergraph · gstbot · Dec 24, 2024 · Dec 24, 2024 · Dec 24, 2024 · Dec 24, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .idea/
 .DS_Store
-
+node_modules
+build
diff --git a/README.adoc b/README.adoc
@@ -6,4 +6,56 @@ This repository only contains the source files for the published documentation.
 To view the published version, see link:https://docs.tigergraph.com/cloud[TigerGraph Cloud Documentation].
 
 == Contribution
-For instructions on how to contribute to this repository, see link:https://github.com/tigergraph/doc-site/blob/main/contribution.adoc[Contribution guidelines].
+For instructions on how to contribute to this repository, see link:https://github.com/tigergraph/doc-site/blob/main/contribution.adoc[Contribution guidelines].
+
+== Install dependencies
+To install dependencies, navigate to this repository and run:
+[,console]
+----
+npm install
+----
+
+== Build site locally
+To build the site locally, run:
+[,console]
+----
+npm run build
+----
+The build will be available in the `build/` folder in the root directory. 
+
+IMPORTANT: Though the files are all in the `/build` folder, you won't be able to access other pages through the links if the files are not served by a server.
+To preview locally, you can <<Run a local server to view the build>>. If you really don't want to use a local server, edit the `antora-playbook.yml` file in your local environment, and change the `html_extension_style` under `urls` to `default`. This allows you to open the static files and have the links work.  
+
+=== Build from your local content source repository
+To have Antora build the site from your local content source repository, change the corresponding content source in the file `antora-playbook.yml` to point to your local git repository. 
+
+See https://docs.antora.org/antora/2.3/playbook/content-source-url/#local-urls[Use local content repositories] on Antora's documentation. 
+
+== Watch Mode
+
+Watch Mode launches a local web server for preview. It will continue watching your local content source repository changes and rebuild the site.
+
+[,console]
+----
+npm run dev
+----
+
+You can access the web server at http://localhost:5000[http://localhost:5000].
+
+== Run a local server to view the build
+
+To open the build, run:
+[,console]
+----
+$ npm i -g http-server
+$ http-server build/site -c-1
+----
+Upon launching the command, the local address of the web server will be displayed in your terminal. You should see the following output in your terminal:
+
+----
+Starting up http-server, serving build/site
+Available on:
+  http://127.0.0.1:8080
+  http://192.168.1.8:8080
+Hit CTRL-C to stop the server
+----
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -0,0 +1,17 @@
+site:
+  title: "Cloud Doc Test"
+  start_page: "savanna:overview:index.adoc"
+
+content:
+  sources:
+    - url: .
+      branches: HEAD
+      start_paths: [modules/savanna, modules/cloud]
+
+output:
+  dir: ./build/site
+
+ui:
+  bundle:
+    url: https://github.com/tigergraph/antora-ui/blob/main/build/ui-bundle.zip?raw=true
+    snapshot: true
diff --git a/gulpfile.js b/gulpfile.js
@@ -0,0 +1,38 @@
+'use strict'
+
+const connect = require('gulp-connect')
+const fs = require('fs')
+const generator = require('@antora/site-generator-default')
+const { reload: livereload } = process.env.LIVERELOAD === 'true' ? require('gulp-connect') : {}
+const { series, src, watch } = require('gulp')
+const yaml = require('js-yaml')
+
+const playbookFilename = 'antora-playbook.yml'
+const playbook = yaml.load(fs.readFileSync(playbookFilename, 'utf8'))
+const outputDir = (playbook.output || {}).dir || './build/site'
+const serverConfig = { name: 'Preview Site', livereload, port: 5000, root: outputDir }
+const antoraArgs = ['--playbook', playbookFilename]
+const watchPatterns = playbook.content.sources.filter((source) => !source.url.includes(':')).reduce((accum, source) => {
+  accum.push(`${source.url}/${source.start_path ? source.start_path + '/' : ''}antora.yml`)
+  accum.push(`${source.url}/${source.start_path ? source.start_path + '/' : ''}**/*.adoc`)
+  return accum
+}, [])
+
+function generate (done) {
+  generator(antoraArgs, process.env)
+    .then(() => done())
+    .catch((err) => {
+      console.log(err)
+      done()
+    })
+}
+
+function serve (done) {
+  connect.server(serverConfig, function () {
+    this.server.on('close', done)
+    watch(watchPatterns, generate)
+    if (livereload) watch(this.root).on('change', (filepath) => src(filepath, { read: false }).pipe(livereload()))
+  })
+}
+
+module.exports = { serve, generate, default: series(generate, serve) }
diff --git a/modules/cloud/modules/billing/pages/index.adoc b/modules/cloud/modules/billing/pages/index.adoc
@@ -15,7 +15,7 @@ Data transfer costs from the cloud platforms are calculated according to the clo
 
 [NOTE]
 ====
-This section only applies to the standard hourly service of TigerGraph Cloud. If you have a committed long-term contract with TigerGraph, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] for questions.
+This section only applies to the standard hourly service of TigerGraph Cloud Classic. If you have a committed long-term contract with TigerGraph, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] for questions.
 ====
 
 == Pricing Information
@@ -27,7 +27,7 @@ View our https://www.tigergraph.com/tigergraph-cloud-pricing/[pricing table] for
 
 image::payment-methods.png[]
 
-For standard hourly use of TigerGraph Cloud clusters, we currently support payment through cards.
+For standard hourly use of TigerGraph Cloud Classic clusters, we currently support payment through cards.
 
 To connect a credit card to your account, click the btn:[Add Credit Card] button in the center of the page.
 You can add multiple cards and set one as the default payment method.
@@ -38,11 +38,11 @@ If you need to use ACH payment or purchase bulk cloud credits, please contact sa
 
 === Subscriptions
 
-You can also pay for TigerGraph Cloud via marketplace subscriptions through a cloud provider:
+You can also pay for TigerGraph Cloud Classic via marketplace subscriptions through a cloud provider:
 
-* https://aws.amazon.com/marketplace/pp/prodview-5rpjtqdqixmds[AWS Marketplace]: Pay for TigerGraph Cloud via AWS
-* https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tigergraph.tigergraph-cloud?tab=Overview[Azure Marketplace]: Pay for TigerGraph Cloud via Azure
-* https://console.cloud.google.com/marketplace/product/tigergraph-public/tigergraph-cloud[GCP Marketplace]: Pay for TigerGraph Cloud via GCP
+* https://aws.amazon.com/marketplace/pp/prodview-5rpjtqdqixmds[AWS Marketplace]: Pay for TigerGraph Cloud Classic via AWS
+* https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tigergraph.tigergraph-cloud?tab=Overview[Azure Marketplace]: Pay for TigerGraph Cloud Classic via Azure
+* https://console.cloud.google.com/marketplace/product/tigergraph-public/tigergraph-cloud[GCP Marketplace]: Pay for TigerGraph Cloud Classic via GCP
 
 == Invoices
 

diff --git a/modules/cloud/modules/reference/pages/aws.adoc b/modules/cloud/modules/reference/pages/aws.adoc
@@ -72,7 +72,7 @@ The table below shows the instance types available on AWS.
 
 == Disk storage
 
-On AWS, disk storage refers to the https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes.html[EBS volume] attached to your TigerGraph Cloud instance. By default, data in disk storage is encrypted-at-rest with platform-managed keys.
+On AWS, disk storage refers to the https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes.html[EBS volume] attached to your TigerGraph Cloud Classic instance. By default, data in disk storage is encrypted-at-rest with platform-managed keys.
 
 Disk storage is charged per GB per hour.
 

diff --git a/modules/cloud/modules/reference/pages/glossary.adoc b/modules/cloud/modules/reference/pages/glossary.adoc
@@ -61,7 +61,7 @@ A database user with its own roles and privileges for different graphs stored on
 
 == vCPU
 
-A virtual central processing unit. A vCPU is a core within a virtual machine inside TigerGraph Cloud.
+A virtual central processing unit. A vCPU is a core within a virtual machine inside TigerGraph Cloud Classic.
 
 == VPC
 
@@ -73,4 +73,4 @@ A network between two VPCs allowing instances to communicate as if they are on t
 
 == web shell
 
-A browser-accessible command line for running GSQL commands on a TigerGraph Cloud cluster.
+A browser-accessible command line for running GSQL commands on a TigerGraph Cloud Classic cluster.
diff --git a/modules/cloud/modules/reference/pages/index.adoc b/modules/cloud/modules/reference/pages/index.adoc
@@ -1,5 +1,5 @@
 = Reference
-:description: References for TigerGraph Cloud documentation.
+:description: References for TigerGraph Cloud Classic documentation.
 :page-aliases: readme.adoc, README.adoc
 
 This section contains the following references:

diff --git a/modules/cloud/modules/reference/pages/service-limits.adoc b/modules/cloud/modules/reference/pages/service-limits.adoc
@@ -1,6 +1,6 @@
 = Service Limits
 
-By default, TigerGraph Cloud limits how many instances and how many vCPUs a single account can provision. These limits can be waived by request if you have a valid credit card on your account. To waive a service limit, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com].
+By default, TigerGraph Cloud Classic limits how many instances and how many vCPUs a single account can provision. These limits can be waived by request if you have a valid credit card on your account. To waive a service limit, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com].
 
 The table below outlines the service limits for accounts with and without a valid credit card.
 

diff --git a/modules/cloud/modules/release-notes/pages/index.adoc b/modules/cloud/modules/release-notes/pages/index.adoc
@@ -2,10 +2,10 @@
 :page-toclevels: 1
 :page-aliases: release-notes.adoc
 
-New updates to TigerGraph Cloud, both to the user experience and the backend capability, are regularly released.
+New updates to TigerGraph Cloud Classic, both to the user experience and the backend capability, are regularly released.
 This page provides a summary of each update upon release.
 
-These TigerGraph Cloud updates are separate from updates to the core TigerGraph architecture. For release notes about new TigerGraph versions, see xref:tigergraph-server:release-notes:index.adoc[TigerGraph Server Release Notes].
+These TigerGraph Cloud Classic updates are separate from updates to the core TigerGraph architecture. For release notes about new TigerGraph versions, see xref:tigergraph-server:release-notes:index.adoc[TigerGraph Server Release Notes].
 
 Cloud clusters are not automatically upgraded to a new TigerGraph version when a new version is released.
 For version upgrades for existing clusters, please contact TigerGraph Support.
@@ -142,7 +142,7 @@ Release date: January 18th, 2023
 * Disk resize limits now match the limits from each cloud service provider.
 
 === Known issues
-* Subscriptions to TigerGraph Cloud from cloud service provider marketplaces occasionally encounter issues during setup.
+* Subscriptions to TigerGraph Cloud Classic from cloud service provider marketplaces occasionally encounter issues during setup.
 Please contact TigerGraph Support for assistance if your account is affected.
 
 == November 2022 Updates
@@ -151,9 +151,9 @@ Release date: November 15th, 2022
 
 === Feature updates
 
-* xref:insights:intro:index.adoc[TigerGraph Insights,] an all-new data visualization platform, is now available in TigerGraph Cloud
-* xref:ml-workbench:on-cloud:on-tgcloud.adoc[Machine Learning Workbench] is now integrated seamlessly into TigerGraph Cloud
-* Added a dedicated starter kit for Machine Learning Workbench on TigerGraph Cloud
+* xref:insights:intro:index.adoc[TigerGraph Insights,] an all-new data visualization platform, is now available in TigerGraph Cloud Classic
+* Machine Learning Workbench is now integrated seamlessly into TigerGraph Cloud Classic
+* Added a dedicated starter kit for Machine Learning Workbench on TigerGraph Cloud Classic
 * Reworked Billing and Analytics pages for improved ease of use
 * TigerGraph 3.8.0 is now available when creating new clusters
 
@@ -219,8 +219,8 @@ Log out and log in again to fix this error.
 Release date: August 18th, 2022
 
 === New Features
-* Users with an invitation can provision xref:ml-workbench:on-cloud:mlwb-service.adoc[ML Workbench (preview version)] instances on top of TigerGraph Cloud clusters.
-** If you are interested in experimenting with ML Workbench on TigerGraph Cloud, please contact sales@tigergraph.com
+* Users with an invitation can provision *ML Workbench (preview version)* instances on top of TigerGraph Cloud Classic clusters.
+** If you are interested in experimenting with ML Workbench on TigerGraph Cloud Classic, please contact sales@tigergraph.com
 * TigerGraph 3.6.2 is available when creating new clusters.
 
 === Feature updates
@@ -235,12 +235,12 @@ Release date: July 6, 2022
 
 * Multiple users can now share access to the same organization account.
 * Role based access control (RBAC) to control and manage access to specific clusters and capabilities.
-* TigerGraph Cloud Console and GraphStudio user authentication are now integrated to eliminate repeated logins.
+* TigerGraph Cloud Classic Console and GraphStudio user authentication are now integrated to eliminate repeated logins.
 * All-new clean and unified user interface.
 
 === Feature Updates
 
-* Username/password authentication has changed for connectors to TigerGraph Cloud instances.
+* Username/password authentication has changed for connectors to TigerGraph Cloud Classic instances.
 ** Users need to create a secret in the Admin Portal UI.
 ** Secrets can only be created through the GUI after a graph has been created.
 ** When entering the credentials, the username needs to be `\__GSQL__secret`, and the password needs to be the secret.
@@ -257,7 +257,7 @@ Release date: June 20, 2022
 
 === Feature updates
 
-* TigerGraph Cloud clusters created on or after June 20, 2022 no longer expose ports 14240 or 9000.
+* TigerGraph Cloud Classic clusters created on or after June 20, 2022 no longer expose ports 14240 or 9000.
 This also applies to previously created clusters that are resized on or after June 20, 2022. Use port 443 instead for API endpoint connectivity:
 ** Use API endpoint `443/restpp/<endpoint>` for RESTPP endpoints that were on port 9000
 ** Use API endpoint `443/<endpoint>` for endpoints that were on port 14240
@@ -266,9 +266,9 @@ Always back up a cluster before performing a resize operation.
 
 === Known issues
 
-* The GSQL Web Shell is temporarily disabled for new clusters due to recent networking improvements on the TigerGraph Cloud backend. Clusters created before June 20, 2022 are unaffected and still have access to the Web Shell.
+* The GSQL Web Shell is temporarily disabled for new clusters due to recent networking improvements on the TigerGraph Cloud Classic backend. Clusters created before June 20, 2022 are unaffected and still have access to the Web Shell.
 
-** Use the xref:tigergraph-server:gsql-shell:using-a-remote-gsql-client.adoc[Remote GSQL client] to access GSQL on new TigerGraph Cloud clusters until access is restored.
+** Use the xref:tigergraph-server:gsql-shell:using-a-remote-gsql-client.adoc[Remote GSQL client] to access GSQL on new TigerGraph Cloud Classic clusters until access is restored.
 
 
 == May 2022 Updates
@@ -296,7 +296,7 @@ Release date: Feb 8th, 2022
 === New features
 
 * TigerGraph Version 3.5 is now available for selection when creating new clusters.
-* Added the framework to render TigerGraph Cloud UIs in other languages besides English.
+* Added the framework to render TigerGraph Cloud Classic UIs in other languages besides English.
 * Improvements on secure access and auditability.
 * Improvements on operational SLAs and faster resolution of issues.
 
@@ -307,8 +307,8 @@ Release date: Sep 22, 2021
 === New features
 
 * **TigerGraph V3.1.5 is now available for selection when creating new clusters**. Users can create clusters that include both single server and cluster deployment when they choose TigerGraph V3.1.5.
-* *VPC Peering*. Users can now create a VPC peering connection between their TigerGraph Cloud VPC and another VPC on all supported cloud providers.
-* *Automatic load balancing for HA clusters*. When users provision a cluster with replicas in TigerGraph Cloud, a load balancer will be automatically attached to the cluster.
+* *VPC Peering*. Users can now create a VPC peering connection between their TigerGraph Cloud Classic VPC and another VPC on all supported cloud providers.
+* *Automatic load balancing for HA clusters*. When users provision a cluster with replicas in TigerGraph Cloud Classic, a load balancer will be automatically attached to the cluster.
 * *Multi-AZ deployment*. When a user provisions an HA cluster, the replicas of the cluster will automatically be provisioned on different availability zones. This feature is supported on AWS and GCP.
 * *Free-tier clusters on GCP*. We now offer the option to create a free-tier cluster on GCP in addition to AWS.
 
@@ -359,7 +359,7 @@ Release Date:  December 16, 2020
 * ✅Support TigerGraph V3.0.6 for New Clusters
 * ✅Support TigerGraph v2.6.4 for New Clusters
 * ✅Support replication factor of 3 for TigerGraph V3.0.6 clusters
-* ✅New TigerGraph Cloud Instance Type TG.C4.M16 available from AWS
+* ✅New TigerGraph Cloud Classic Instance Type TG.C4.M16 available from AWS
 * ✅SOC2 Type 2 report available to request
 * ✅5 New TigerGraph Starter Kits
 ** Graph Convolutional Networks (V3.0.6)
@@ -412,7 +412,7 @@ Release Date:  April 27, 2020
 *** Centrality
 *** Community Detection
 
-== TigerGraph Cloud V2.0
+== TigerGraph Cloud Classic V2.0
 
 Release Date: January 08, 2020
 
@@ -425,7 +425,7 @@ Release Date: January 08, 2020
 * ✅Added Steps in Cloud Portal Provision Workflow
 * ✅New TigerGraph Starter Kits
 
-== TigerGraph Cloud V1.0
+== TigerGraph Cloud Classic V1.0
 
 Release Date: September 25, 2019
 
@@ -438,7 +438,7 @@ Sunset Date: March 31, 2020
 * ✅Free Credits for 1st Time Sign Up
 * ✅Available in 8 Tiers of Instances (Free Tier Included) and 6 Global Regions
 * ✅Flexible Billing and Pay As You Go Pricing
-* ✅Secure and Isolated Network (VPC) for Each TigerGraph Cloud Account
+* ✅Secure and Isolated Network (VPC) for Each TigerGraph Cloud Classic Account
 * ✅Fast Data Loading through S3 and Local Files
 * ✅13 TigerGraph Starter Kits with Sample Datasets and Queries
 * ✅Start/Stop/Terminate TigerGraph Clusters On Demand through Cloud Portal

diff --git a/modules/cloud/modules/security/pages/idp.adoc b/modules/cloud/modules/security/pages/idp.adoc
@@ -1,17 +1,17 @@
 = IDP integration with SSO
 
-By default, user management in a TigerGraph Cloud organization happens in the xref:manage-org-users.adoc[] section of the TigerGraph Cloud interface.
+By default, user management in a TigerGraph Cloud Classic organization happens in the xref:manage-org-users.adoc[] section of the TigerGraph Cloud Classic interface.
 
-If you have another preferred identity provider (IDP), you can integrate with it instead using SAML 2.0 to handle your user management needs outside of TigerGraph Cloud.
+If you have another preferred identity provider (IDP), you can integrate with it instead using SAML 2.0 to handle your user management needs outside of TigerGraph Cloud Classic.
 
 IDP integration is currently available at the Organization level, so one IDP will handle user management for all clusters in that organization.
 Only one IDP can be connected to a single Organization.
 
 == Process Outline
 
-. Have IDP enabled on your TigerGraph Cloud Organization account.
-. Create an app integration on the IDP side to configure it to link with TigerGraph Cloud.
-. Users log in to the TigerGraph Cloud portal using credentials from your IDP.
+. Have IDP enabled on your TigerGraph Cloud Classic Organization account.
+. Create an app integration on the IDP side to configure it to link with TigerGraph Cloud Classic.
+. Users log in to the TigerGraph Cloud Classic portal using credentials from your IDP.
 . Organization Admins assign roles to the users being created in the cloud organization via successful login from the IDP.
 
 == Setup

diff --git a/modules/cloud/modules/security/pages/index.adoc b/modules/cloud/modules/security/pages/index.adoc
@@ -1,8 +1,8 @@
 = Security
 :page-aliases: readme.adoc, README.adoc
 
-TigerGraph Cloud leverages the secured infrastructure of our cloud service providers and provides additional security features to ensure the security of your data and network.
-This page provides an overview of the security features available on TigerGraph Cloud.
+TigerGraph Cloud Classic leverages the secured infrastructure of our cloud service providers and provides additional security features to ensure the security of your data and network.
+This page provides an overview of the security features available on TigerGraph Cloud Classic.
 
 
 == Network access