Skip to content

Commit

Permalink
Restructure cloud doc
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 23, 2024
1 parent eb9f3e3 commit e2ea172
Show file tree
Hide file tree
Showing 182 changed files with 144 additions and 123 deletions.
12 changes: 6 additions & 6 deletions modules/cloud4/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ start_page: overview:index.adoc

nav:
- modules/overview/nav.adoc
- modules/release-notes/nav.adoc
- modules/get-started/nav.adoc
- modules/resource-manager/nav.adoc
- modules/load-data/nav.adoc
- modules/schema-designer/nav.adoc
- modules/gsql-editor/nav.adoc
- modules/explore-graph/nav.adoc
- modules/graph-development/nav.adoc
# - modules/load-data/nav.adoc
# - modules/schema-designer/nav.adoc
# - modules/gsql-editor/nav.adoc
# - modules/explore-graph/nav.adoc
- modules/integrations/nav.adoc
- modules/administration/nav.adoc
- modules/rest-api/nav.adoc
- modules/security/nav.adoc
- modules/billing-manager/nav.adoc
# - modules/billing-manager/nav.adoc
- modules/resources/nav.adoc
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions modules/cloud4/modules/administration/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
* xref:index.adoc[Administration]
** xref:administration:how2-invite-users.adoc[]
** xref:administration:how2-access-mgnt.adoc[]
** xref:administration:billing/index.adoc[Billing]
*** xref:administration:billing/payment-methods.adoc[]
*** xref:administration:billing/invoices.adoc[]
** xref:administration:settings/index.adoc[Settings]
*** xref:administration:settings/how2-use-organization-mgnt.adoc[]
*** xref:administration:settings/how2-create-api-key.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ image::Screenshot 2024-04-28 at 12.11.56 PM.png[]

Check out the links below to explore more billing information to utilize.

== xref:cloud4:billing-manager:payment-methods.adoc[]
== xref:cloud4:administration:billing/payment-methods.adoc[]

Learn how you can manage payment methods.

== xref:billing-manager:invoices.adoc[]
== xref:cloud4:administration:billing/invoices.adoc[]

Learn how to view and export invoices.

== xref:cloud4:billing-manager:pricing.adoc[]
== xref:cloud4:administration:billing/pricing.adoc[]

Here you can review pricing information in TigerGraph Cloud 4.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,40 +1,47 @@
= TigerGraph Cloud 4 API Key
:experimental:
= API Keys
:experimental:

As an organization administrator, you have access to organization management features that allow you to configure organization settings.

== Manage Organization Setting

.To make organization settings changes:
. Navigate to the btn:[Setting] tag
+
image::Screenshot 2024-04-18 at 10.23.26 AM.png[width=300]

. Once clicked, the btn:[Organization Setting] panel will display the btn:[Basic Information] used with each organization.
+
image::Screenshot 2024-04-18 at 10.22.57 AM.png[]
+
.Here you will find the basic information to set up a new organization.
* *Organization Name*: The name of your organization within TigerGraph Cloud.
This is a unique identifier for your organization and is used for administrative purposes.
* *Display Name*: The display name is the name that will be shown in the user interface and other user-facing areas.
It can be a more user-friendly or descriptive name compared to the organization name.
+
[TIP]
[IMPORTANT]
====
The display name helps users easily identify your organization within TigerGraph Cloud.
The TigerGraph Cloud 4 REST API is currently in preview version. Features and endpoints may change as the API evolves.
====
* *Organization Logo URL*: The URL to the logo image file for your organization.
This logo will be displayed in the TigerGraph Cloud navigation bar and can be used to represent your organization visually.
+
[TIP]

== Overview

API keys are essential for authenticating and securing access to the TigerGraph Cloud REST API. This guide will walk you through the steps to create, configure, and manage your API keys.

== Creating an API Key

To create an API key, follow these steps:

.1. **Navigate to Orgnization Settings:**
- Select the `Admin` → `Settings` menu on the navigation bar.
- If you cannot see the menu, please ask your organization administrator for access.

.2. **Access the API Keys Section:**
- In the settings dashboard, find and click on the `API Keys` tab at the top.

.3. **Create a New API Key:**
- Click on the btn:[ Create API Keys] button.
- Provide a name or description for the API key to help you identify its purpose later.
- Select the permissions you want to grant to the API key.
- Optionally, set an expiration date for the API key for added security.

image::create-api-key.png[]

.4. **Save the API Key:**
- Once the API key is generated, copy it and store it in a secure location. You will not be able to view this key again after you leave the page.

[NOTE]
====
Providing a logo adds a professional touch and helps users quickly recognize your organization within TigerGraph Cloud.
Treat your API key like a password. Do not share it or expose it in your code or public repositories.
====

== Next Steps

Next, continue on to learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Next, continue on to learn about xref:cloud4:rest-api:authentication.adoc[] or xref:cloud4:rest-api:endpoints.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
9 changes: 0 additions & 9 deletions modules/cloud4/modules/billing-manager/nav.adoc

This file was deleted.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 0 additions & 2 deletions modules/cloud4/modules/explore-graph/nav.adoc

This file was deleted.

13 changes: 13 additions & 0 deletions modules/cloud4/modules/graph-development/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
* xref:index.adoc[Graph Management]
** xref:load-data/index.adoc[Load Data]
*** xref:load-data/load-from-local.adoc[]
*** xref:load-data/load-from-s3.adoc[]
*** xref:load-data/load-from-gcs.adoc[]
*** xref:load-data/load-from-blob.adoc[]
*** xref:load-data/load-from-other-sources.adoc[]
**** xref:load-data/jdbc.adoc[]
** xref:schema-designer/index.adoc[Design Schema]
** xref:gsql-editor/index.adoc[GSQL Editor]
*** xref:gsql-editor/how2-edit-gsql-query.adoc[Edit Query]
** xref:explore-graph/index.adoc[Explore Graph]
*** xref:explore-graph/how2-use-pattern-search.adoc[Pattern Search]
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ image::Screenshot 2024-10-11 at 11.39.23.png[]
+
[NOTE]
====
For more details please see xref:cloud4:schema-designer:index.adoc[].
For more details please see xref:cloud4:graph-development:schema-designer/index.adoc[].
====

* Main area image:main.png[] Main GSQL Editing Panel.
Expand Down Expand Up @@ -120,7 +120,7 @@ You can easily open the Schema Designer in GSQL Editor by clicking on the image:

[NOTE]
====
For more details please see xref:cloud4:schema-designer:index.adoc[].
For more details please see xref:cloud4:graph-development:schema-designer/index.adoc[].
====

== Next Steps
Expand Down
1 change: 1 addition & 0 deletions modules/cloud4/modules/graph-development/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= Graph Managment
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Here you can check out the status of loading data form other sources in TigerGra
Or check out our xref:cloud4:load-data:jdbc.adoc[].

== Next Steps
Next, learn more about how to xref:cloud4:schema-designer:index.adoc[].
Next, learn more about how to xref:cloud4:graph-development:schema-designer/index.adoc[].

Or return to the xref:cloud4:resource-manager:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The header name is ignored during data loading.

== 3) Configure Map

.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:schema-designer:index.adoc[Schema Designer].
.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema].
. Select `Generate the schema only` or `Generate the schema and data mapping`.
+
image::Screenshot 2024-04-17 at 5.55.35 PM.png[]
Expand Down Expand Up @@ -102,7 +102,7 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[]

== Next Steps

Next, learn how to use the xref:cloud4:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The header name is ignored during data loading.

== 3) Configure Map

.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:schema-designer:index.adoc[Schema Designer].
.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema].
. Select `Generate the schema only` or `Generate the schema and data mapping`.
+
image::Screenshot 2024-04-17 at 5.55.35 PM.png[]
Expand Down Expand Up @@ -102,7 +102,7 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[]

== Next Steps

Next, learn how to use the xref:cloud4:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The header name is ignored during data loading.

== 3) Configure Map

.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:schema-designer:index.adoc[Schema Designer].
.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema].
. Select `Generate the schema only` or `Generate the schema and data mapping`.
+
image::Screenshot 2024-04-17 at 5.55.35 PM.png[]
Expand Down Expand Up @@ -99,7 +99,7 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[]

== Next Steps

Next, learn how to use the xref:cloud4:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Additionally, data can also be loaded from a JDBC Connection as well, See xref:c

== Next Steps

Next, learn how to use the xref:cloud4:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The header name is ignored during data loading.

== 3) Configure Map

.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:schema-designer:index.adoc[Schema Designer].
.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema].
. Select `Generate the schema only` or `Generate the schema and data mapping`.
+
image::Screenshot 2024-04-17 at 5.55.35 PM.png[]
Expand Down Expand Up @@ -102,7 +102,7 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[]

== Next Steps

Next, learn how to use the xref:cloud4:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,6 @@ image::advanced-settings-2.png[]

== Next Steps

Next, learn how to use the xref:gsql-editor:index.adoc[GSQL Editor] in TigerGraph Cloud 4.
Next, learn how to use xref:gsql-editor:index.adoc[GSQL Editor] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
2 changes: 0 additions & 2 deletions modules/cloud4/modules/gsql-editor/nav.adoc

This file was deleted.

Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
7 changes: 0 additions & 7 deletions modules/cloud4/modules/load-data/nav.adoc

This file was deleted.

3 changes: 3 additions & 0 deletions modules/cloud4/modules/overview/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
* xref:index.adoc[Introduction]
** xref:overview:overview.adoc[Overview]
** xref:cloud4:overview:comparison_table.adoc[Compare Different Offerings]
** xref:cloud4:overview:release-notes.adoc[Release Notes]
** xref:cloud4:overview:pricing.adoc[]
** xref:cloud4:overview:cost-estimation.adoc[]
31 changes: 31 additions & 0 deletions modules/cloud4/modules/overview/pages/cost-estimation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
= Cost Estimation

Here, you can configure various parameters to estimate your monthly costs for using TigerGraph Cloud 4. This tool allows you to tailor your workspace size, monthly usage, and database size to get a clear understanding of your anticipated expenses.

++++
<iframe
src="https://portal.tgcloud-dev.com/price.html"
width="100%"
height="628px"
frameborder="0"
sandbox="allow-scripts allow-top-navigation allow-same-origin allow-popups"
>
</iframe>
<script>
window.addEventListener("message", function (event) {
const data = event.data;
if (data && data.type === "resize") {
const iframe = document.querySelector("iframe");
iframe.style.height = `${data.height}px`;
}
});
</script>
++++

== Next Steps

Next, see xref:cloud4:get-started:index.adoc[] to unlock its full potential.

Return to xref:cloud4:overview:index.adoc[TigerGraph Cloud 4] for another topic.
28 changes: 3 additions & 25 deletions modules/cloud4/modules/overview/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ xref:load-data:load-from-blob.adoc[Azure Blob Storage] |
xref:load-data:load-from-other-sources.adoc[Other Sources]
¦
image:TG_Icon_Library-135.png[alt=schemadesigner,width=74,height=74]
*Schema Designer*
*Design Schema*

xref:cloud4:schema-designer:index.adoc[] teaches you how to you can easily modify and manage the schema of your graph databases using Schema Designer UI.
xref:cloud4:graph-development:schema-designer/index.adoc[Design Schema] teaches you how to you can easily modify and manage the schema of your graph databases using Schema Designer UI.

¦
image:schema-homecard.png[alt=gsqlEditor,width=74,height=74]
Expand Down Expand Up @@ -134,26 +134,4 @@ xref:cloud4:resources:glossary.adoc[] |
xref:cloud4:resources:terms_conditions.adoc[ Beta Terms and Conditions] |
xref:cloud4:resources:support.adoc[]

|===

++++
<iframe
src="https://portal.tgcloud-dev.com/price.html"
width="100%"
height="628px"
frameborder="0"
sandbox="allow-scripts allow-top-navigation allow-same-origin allow-popups"
>
</iframe>
<script>
window.addEventListener("message", function (event) {
const data = event.data;
if (data && data.type === "resize") {
const iframe = document.querySelector("iframe");
iframe.style.height = `${data.height}px`;
}
});
</script>
++++
|===
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ A TigerGraph Credit (TCR) is a unit that represents the cost of using compute re

The exchange rate for TigerGraph Credits is straightforward:

.1 TCR = $4.00
**1 TCR = $4.00


This means that for every TigerGraph Credit you consume, you will be billed $4.00.
Expand Down Expand Up @@ -216,8 +216,7 @@ Learn more about the available add-ons xref:integrations:add-ons.adoc[here].

== Next Steps

Next, learn about other billing topics on the xref:billing-manager:index.adoc[] page or check out the xref:resources:index.adoc[] section.
Next, see xref:cloud4:overview:cost-estimation.adoc[] or learn more billing topics at xref:cloud4:administration:billing/index.adoc[].

Return to the page to xref:cloud4:overview:index.adoc[Overview] page for a different topic.


Loading

0 comments on commit e2ea172

Please sign in to comment.