Skip to content

Commit

Permalink
Update2CloudDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Newman authored and Joseph Newman committed Apr 11, 2024
1 parent 399643a commit 480d391
Show file tree
Hide file tree
Showing 23 changed files with 365 additions and 34 deletions.
2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/administration/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* xref:index.adoc[]
* xref:index.adoc[Administration]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Access Management
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
= Invite Users
When you set up a TigerGraph Cloud 4.0 account, you are granted the privileges of an Organization Admin for your company.

An Organization Admin can manage multiple users in your organization and control their access to various resources.

This page explains the user access controls.

[NOTE]
For help with setting up workspaces, visit xref:resource-manager:how2-create-a-workspace.adoc[]
2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/billing-manager/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* xref:index.adoc[]
* xref:index.adoc[Billing]
6 changes: 3 additions & 3 deletions modules/cloudbeta/modules/get-started/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
* xref:index.adoc[]
** xref:how2-signup.adoc[]
** xref:organization-management.adoc[]
* xref:index.adoc[Get Started]
** xref:how2-signup.adoc[Sign Up]
** xref:how2-login.adoc[Log In]
28 changes: 28 additions & 0 deletions modules/cloudbeta/modules/get-started/pages/how2-login.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
= How to Log In
:experimental:

After first xref:get-started:how2-signup.adoc[signing up] users must btn:[Login].

This guide will walk you through the necessary steps.

== Login
Click btn:[Log In] on the https://tgcloud.io/[TigerGraph Cloud landing page].

When you log in, you must first provide an organization name before entering your username and password.

====
If you were invited by a member of your organization and you do not know the name used for the organization account, contact your organization’s administrator.
====

[Placeholder for new cloud login page]

Once logged in, you can create begin to create xref:resource-manager:workgroup.adoc[Workgroups] and xref:resource-manager:workspace.adoc[Workspaces], xref:administration:invite_users.adoc[] to your organization, and xref:administration:access_mgnt.adoc[manage access].

////
. xref:resource-manager:how2-create-a-workgroup.adoc[Create a Workgroup]
. xref:resource-manager:how2-create-a-workspace.adoc[Create a Workspace]
. xref:administration:invite_users.adoc[]
. xref:administration:access_mgnt.adoc[]
Once logged in, you can create begin to create xref:resource-manager:workgroup.adoc[Workgroups] and xref:resource-manager:workspace.adoc[Workspaces].
////
28 changes: 26 additions & 2 deletions modules/cloudbeta/modules/get-started/pages/how2-signup.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
= How to Sign Up
:experimental:

In order to use TigerGraph Cloud v4.0 (beta) users must first btn:[Sign Up].

This guide will walk you through the necessary steps.

== Sign Up
Click btn:[Sign Up] https://tgcloud.io[on the TigerGraph Cloud landing page].

{Placeholder for new cloud landing page}

If you are signing up for the first time, you will be prompted to enter a password.


[CAUTION]
Please refer to out xref:security:password-policy.adoc[] that applies to TigerGraph Cloud.

When registering for a new TigerGraph Cloud account, we will ask to confirm your email address.

btn:[ Click ] the link in your email to verify, then log in using your username and password.

[NOTE]
We automatically create an new org for you.

The next step is to xref:how2-login.adoc[Log in].


== Introduction

== Steps
18 changes: 14 additions & 4 deletions modules/cloudbeta/modules/get-started/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
= Get Started with TigerGraph Cloud (Beta)
:experimental:

To get started with TigerGraph Cloud v4.0 (beta) users must first Sign Up and Login.

These guide will walk you through the necessary steps.

== xref:how2-signup.adoc[]

Learn how to create a TigerGraph Cloud 4.0 account and get access to the platform.

== xref:how2-login.adoc[]

Learn how to login to your TigerGraph Cloud 4.0 account.




== Introduction

== Prerequisites

== Glossary

== v4.0 Changes

2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/gsql-editor/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* xref:index.adoc[]
* xref:index.adoc[GSQL Editor]
** xref:gsql-editor:how2-edit-gsql-query.adoc[Edit Query]
3 changes: 2 additions & 1 deletion modules/cloudbeta/modules/integrations/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
* xref:index.adoc[]
* xref:index.adoc[Integrations]
** xref:solutions.adoc[]
** xref:add-ons.adoc[]
*** xref:integrations:copilot.adoc[Co-pilot]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= How to use Solutions

== Introduction

== Steps
18 changes: 17 additions & 1 deletion modules/cloudbeta/modules/integrations/pages/solutions.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
= Solutions
= Solutions

== Introduction

An array of industry standard graph soultions.

prebuld and fully production grade soultions.
For diverase industryies and use cases

Disgned for users to shiftly adobt graph techincalogy

== Prerequisites

== How to use Solutions

Learn about how to get started with this how to guide on using soultions.
In our transaction fraud case example
5 changes: 3 additions & 2 deletions modules/cloudbeta/modules/load-data/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* xref:index.adoc[]
* xref:index.adoc[Load Data]
** xref:load-data:load-from-local.adoc[]
** xref:load-data:load-from-cloud.adoc[]
** xref:load-data:load-from-other-sources.adoc[]
** xref:load-data:load-from-other-sources.adoc[]
*** xref:load-data:jdbc.adoc[]
2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/overview/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* xref:index.adoc[]
* xref:index.adoc[Cloud 4.0 (Beta)]
103 changes: 96 additions & 7 deletions modules/cloudbeta/modules/overview/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
= TigerGraph Cloud (Beta)
= TigerGraph Cloud 4.0 (Beta)
:experimental:
:page-aliases: cloud-overview.adoc

This documentation will guide you through the various features and functionalities of our brand new cloud-native graph as a service (GaaS) management platform.
TigerGraph Cloud 4.0 offers a powerful and user-friendly environment for managing, analyzing, and exploring your graph data.

[CAUTION]
====
TigerGraph Cloud 4.0 is still in beta release and the documentation is in progress.
====

== Get to Know Your TigerGraph Cloud

Expand All @@ -11,10 +18,10 @@
image:getstarted-homecard.png[alt=getstarted,width=74,height=74]
*Get Started*

xref:cloudBeta:get-started:index.adoc[Get Started] using TigerGraph Cloud with the v4.0 Beta.
xref:cloudBeta:get-started:index.adoc[Get Started] using TigerGraph Cloud with the 4.0 beta.

xref:get-started:how2-signup.adoc[How to Sign Up] |
xref:get-started:organization-management.adoc[]
xref:administration:organization-management.adoc[Org Management]

¦
image:billing-homecard.png[alt=billing,width=74,height=74]
Expand All @@ -30,14 +37,14 @@ image:insights.png[alt=workspace,width=74,height=74]
Learn how to dynamically allocate compute and storage resources.

xref:resource-manager:index.adoc[Overview] |
xref:resource-manager:workgroup.adoc[] |
xref:resource-manager:workspace.adoc[]
xref:resource-manager:workgroup.adoc[Workgroup] |
xref:resource-manager:workspace.adoc[Workspace]

¦
image:DataLoading-Homecard.png[alt=load data,width=74,height=74]
*Load Data*

Learn how to xref:load-data:index.adoc[Load Data] into TigerGraph Cloud.
Learn how to xref:load-data:index.adoc[Load Data] into TigerGraph Cloud 4.0.

xref:load-data:index.adoc[Overview] |
xref:load-data:load-from-local.adoc[Local] |
Expand Down Expand Up @@ -70,6 +77,8 @@ xref:security:index.adoc[Overview] |
image:ArchtectureOverview-homecard.png[alt=integration,width=74,height=74]
*Integration*

TigerGraph Cloud 4.0 offers several powerful integration tools.

xref:integrations:index.adoc[Overview] |
xref:integrations:copilot.adoc[]
¦
Expand All @@ -82,7 +91,87 @@ View the xref:release-notes:index.adoc[] to get update information on features a
image:referece-homecard.png[alt=ref,width=74,height=74]
*Resources*

Here you can find any additional xref:resources:index.adoc[Resources] for TigerGraph Cloud v4.0 (beta)
Here you can find any additional xref:resources:index.adoc[Resources] for TigerGraph Cloud v4.0 (beta).

¦
|===

== Comparison with TigerGraph Enterprise Server

Most of the documentation for TigerGraph Enterprise Server also applies to TigerGraph Cloud.
However, since TigerGraph Cloud does not have a command-line interface on the OS level, command-line features are not supported in the same way.
In many cases, there is a GUI-based method for the same feature.
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).
|===
10 changes: 9 additions & 1 deletion modules/cloudbeta/modules/release-notes/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,16 @@ TigerGraph Cloud v4.0.0 (Beta) was released on [release date]

LTS versions are supported for 24 months from their initial release (X.X.0) and should be the choice for production deployments.

== Key New Features
== (Beta) Key Features
=== 4.0.0
* xref:resource-manager:workgroup.adoc[Workgroups] and xref:resource-manager:workspace.adoc[Workspaces] give users control over resource management.

* xref:gsql-editor:index.adoc[GSQL Editor] -

* xref:explore-graph:index.adoc[] and xref:explore-graph:pattern-search.adoc[] -



* Description and link - Detailed information.

== Fixed issues
Expand Down
2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/resource-manager/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
* xref:index.adoc[]
** xref:workgroup.adoc[Workgroups]
*** xref:resource-manager:how2-create-a-workgroup.adoc[Create Workgroup]
*** xref:workspace.adoc[Workspace]
** xref:workspace.adoc[Workspace]
**** xref:how2-create-a-workspace.adoc[Create Workspace]
**** xref:resource-manager:workspace-privileges.adoc[]
**** xref:resource-manager:auto-start-stop.adoc[]
Expand Down
7 changes: 6 additions & 1 deletion modules/cloudbeta/modules/resources/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
* xref:index.adoc[]
* xref:index.adoc[Resources]
** xref:resources:glossary.adoc[]
** xref:resources:support.adoc[]
** xref:resources:faqs.adoc[FAQs]
** xref:resources:quota_policy.adoc[Restriction Policy]
** xref:resources:terms_conditions.adoc[Terms and Conditions]
23 changes: 18 additions & 5 deletions modules/cloudbeta/modules/resources/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
= Resources Overview
= Resources
:experimental:

Resources provide other documents to help support your TigerGraph Cloud 4.0 (beta) journey.

== Introduction
== xref:resources:glossary.adoc[]

== Prerequisites
Here you can refer terms used in TigerGraph Cloud and the 4.0 (beta).

== Glossary
== xref:resources:support.adoc[]

Here you can learn how to get support.

== xref:resources:faqs.adoc[Cloud 4.0 FAQs]

Here you can find Cloud 4.0 FAQs.

== Policy Documents

If you are a participating TigerGraph Cloud 4.0 (Beta) user, please review our policy documents:

* xref:quota_policy.adoc[Beta Phase Quota Restriction Policy]
* xref:terms_conditions.adoc[Beta Program Terms and Conditions]

== v4.0 Changes

Loading

0 comments on commit 480d391

Please sign in to comment.