TCE-4760 feat(byoc): update directory and wordings

Author: duchoaile

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
+----

antora-playbook.yml

@@ -0,0 +1,17 @@
+site:
+  title: "Cloud Doc Test"
+  start_page: "cloud4:overview:index.adoc"
+
+content:
+  sources:
+    - url: .
+      branches: HEAD
+      start_paths: [modules/cloud4, 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

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) }

modules/cloud/antora.yml

@@ -1,8 +1,8 @@
 name: cloud
-title: TigerGraph Cloud
-version: master
-display_version: default
+title: TigerGraph Cloud Classic
 start_page: start:overview.adoc
+version: main
+display_version: default
 
 nav:
 - modules/start/nav.adoc

modules/cloud/modules/solutions/pages/access-solution/graphstudio.adoc

@@ -16,6 +16,6 @@ image::full-cluster-actions-dropdown.png[]
 
 == Use GraphStudio
 
-To learn how to use GraphStudio, read our xref:gui:graphstudio:overview.adoc[GraphStudio UI Guide].
+To learn how to use the GraphStudio™ design interface, read our xref:gui:graphstudio:overview.adoc[GraphStudio™ UI Guide].
 
 

modules/cloud/modules/start/pages/get_started.adoc

@@ -54,71 +54,21 @@ For advanced OS-level commands, submit a support ticket for more information.
 |===
 | Topic | TigerGraph Enterprise Server | TigerGraph Cloud
 
-| GSQL Graph Algorithm Library
-| Yes
-| Yes
-
-| Release Notes
-| Yes
-| TigerGraph Cloud provides database versions kept up to date with TigerGraph Server releases.
-
-| GSQL 101
-| Yes
-| Basic concepts still apply, most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach.
-
-| GSQL 102 Pattern Matching
-| Yes
-| The same patterns can be used in queries.
-
-| MultiGraph Overview
-| Yes
-| Yes
-
-| Hardware and Software Requirements
-| Yes
-| N/A
-
-| Installation and Configuration
-| Yes
-| N/A. There are a few simple steps to install a Starter Kit.  See the TigerGraph Cloud FAQs.
-
-| User Access Management
-| Yes
-| Yes
-
-| Data Encryption
-| Yes
-| N/A. TigerGraph Cloud is setup already for encrypted data at rest and at motion.
-
-| System Management
-| Yes
-| The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal.  Backup and Restore is done through the Cloud Admin Portal.
-
-| GraphStudio UI Guide
-| Yes
-| Yes
-
-| GSQL Demo Examples
-| Yes
-| Yes
-
-| GSQL Language Reference, Part 1 Data Definition and Loading
-| Yes
-| Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio, or submit support request to import into the filesystem. In addition, the operations can be performed through the GraphStudio user interface.
-
-| GSQL Language Reference, Part 2 Querying
-| Yes
-| Yes
-
-| RESTPP API User Guide
-| Yes
-| Yes. Note the URL assigned to your cluster.
-
-| Transaction Processing and ACID Support
-| Yes
-| Yes
-
-| Data Loader User Guides
-| Yes
-| S3 Loader can be used through the GraphStudio interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers).
+| GSQL Graph Algorithm Library | Yes | Yes
+| Release Notes | Yes | TigerGraph Cloud keeps its database instances up to date with the latest TigerGraph Server releases.
+| GSQL 101 | Yes | Basic concepts still apply. Most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach.
+| GSQL 102 Pattern Matching | Yes | The same patterns can be used in queries.
+| MultiGraph Overview | Yes | Yes
+| Hardware and Software Requirements | Yes | N/A
+| Installation and Configuration | Yes | N/A. There are a few simple steps to install a Starter Kit.  See the TigerGraph Cloud FAQs.
+| User Access Management | Yes | Yes
+| Data Encryption | Yes | N/A. TigerGraph Cloud is setup already for encrypted data at rest and at motion.
+| System Management | Yes | The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal.  Backup and Restore is done through the Cloud Admin Portal.
+| GraphStudio UI Guide | Yes | Yes
+| GSQL Demo Examples | Yes | Yes
+| GSQL Language Reference, Part 1 Data Definition and Loading| Yes | Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio, or submit support request to import into the filesystem. In addition, the operations can be performed through the GraphStudio user interface.
+| GSQL Language Reference, Part 2 Querying | Yes | Yes
+| RESTPP API User Guide | Yes | Yes. Note the URL assigned to your cluster.
+| Transaction Processing and ACID Support | Yes | Yes
+| Data Loader User Guides | Yes | S3 Loader can be used through the GraphStudio interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers).
 |===

modules/cloud/modules/start/pages/overview.adoc

@@ -1,19 +1,25 @@
-= TigerGraph Cloud
+= TigerGraph Cloud Classic
 :experimental:
 :page-aliases: cloud-overview.adoc
 
+
 TigerGraph Cloud is a fully-managed cloud database built on the Enterprise Server engine and completely integrated with the full TigerGraph Suite.
 
 Everything including xref:3.9@gui:admin-portal:overview.adoc[Admin Portal], xref:3.9@gui:graphstudio:overview.adoc[GraphStudio], xref:3.9@insights:intro:index.adoc[Insights], xref:1.4@ml-workbench:intro:index.adoc[ML Workbench], as well as,
 handling all the complexity of deploying and managing your deployments on the cloud service provider of your choice ( xref:cloud:reference:aws.adoc[], xref:cloud:reference:azure.adoc[], and xref:cloud:reference:gcp.adoc[] ).
 
 [NOTE]
 ====
-TigerGraph Cloud 4.0 (beta version) was released on Apr. 29th, 2024.
+TigerGraph Savanna Beta was released on Apr. 29, 2024.
 
-Check out the new Cloud 4.0 beta at https://beta.tgcloud.io or have a look at the xref:cloudBeta:overview:index.adoc[Documentation] for more details.
+Check out the new Savanna at https://savanna.tgcloud.io or have a look at the xref:savanna:overview:index.adoc[Documentation] for more details.
 ====
 
+// [NOTE]
+// ====
+// On December 31, 2025, we'll retire the TigerGraph Cloud Classic platform. Before that date, you’ll need to migrate your data from TigerGraph Cloud Classic to TigerGraph Savanna. For support, please contact us at [email protected].
+// ====
+
 == Get to Know Your TigerGraph Cloud
 
 [.home-card,cols="2",grid=none,frame=none, separator=¦]
@@ -36,7 +42,6 @@ image:security-homecard.png[alt=security,width=74,height=74]
 
 Learn how TigerGraph Cloud can help ensure the xref:cloud:security:index.adoc[Security] of your data and network.
 
-
 ¦
 image:billing-homecard.png[alt=billing,width=74,height=74]
 *Billing*
@@ -62,6 +67,6 @@ See other documents to help support your TigerGraph Cloud journey.
 xref:cloud:reference:index.adoc[Reference |]
 xref:cloud:reference:glossary.adoc[Glossary |]
 xref:cloud:reference:service-limits.adoc[Service Limits]
-¦
+
 |===
 

modules/cloud/modules/support/pages/faqs.adoc

@@ -179,7 +179,7 @@ In addition, for TigerGraph paid tier clusters, users can use GSQL Web Shell to
 
 A: TigerGraph uses GSQL, the query language designed for fast and scalable graph operations and analytics. GSQL's similarity to SQL, high-level syntax, Turing completeness, and built-in parallelism brings faster performance, faster development and the ability to describe any algorithm.
 
-You can start learning GSQL from our xref:3.5@gsql-ref:tutorials:gsql-101/index.adoc[GSQL tutorials]. We also support a RESTful API and JSON output for easy integration with application languages like Python, Java, and C{pp}.
+You can start learning GSQL from our xref:gsql-ref:tutorials:gsql-101/index.adoc[GSQL tutorials]. We also support a RESTful API and JSON output for easy integration with application languages like Python, Java, and C{pp}.
 
 Start learning GSQL and become a TigerGraph Certified Associate today with our link:https://www.tigergraph.com/certification/[Certification Program].
 
@@ -190,7 +190,7 @@ A: Yes. If you use V3.0.5+ in TigerGraph Cloud, MultiGraph is supported through
 
 === *Q: What methods do you support for importing data?*
 
-A: We support AWS S3 import, Google Cloud Storage,  and local file upload through GraphStudio. Spark loading is available through our open source JDBC Driver. See https://github.com/tigergraph/ecosys/tree/master/tools/etl[https://github.com/tigergraph/ecosys/tree/master/etl]
+A: We support loading data from Amazon S3, Google Cloud Storage, and local files through GraphStudio. Spark loading is available through our open-source JDBC Driver. See https://github.com/tigergraph/ecosys/tree/master/tools/etl[https://github.com/tigergraph/ecosys/tree/master/etl]
 
 In addition, for TigerGraph paid tier clusters, users can use the GSQL Web Shell to write GSQL Commands in an interactive command line shell. This GSQL Web Shell opens up more data loading options such as S3 Loader (parquet format), Kafka Loader and other complex loading jobs. Users can access GSQL Web Shell through the cluster panel from their Cloud Portal.