Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2118 feat(tgcloud4): Cloud v4 Docs; #68

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

DOC-2118 feat(tgcloud4): Cloud v4 Docs; #68

Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
607ba3a
Update index.adoc
victorleeTG Jul 23, 2024
8235c28
Update antora-playbook.yml
victorleeTG Jul 23, 2024
28d0d3a
disable the "current" version alias
victorleeTG Sep 20, 2024
a0aa4d2
switch the direction of url version alias behavior
victorleeTG Sep 20, 2024
fe74075
DOC-2230 fix cloudbeta redirects - cloud-dev branch
victorleeTG Sep 26, 2024
170eb60
Update antora-playbook.yml
pengchengrun Sep 26, 2024
d475a51
Update antora-playbook.yml
pengchengrun Sep 27, 2024
11fc2c1
Revert "Update antora-playbook.yml"
samzhou2 Sep 27, 2024
cedf2e3
fixed the branch issue
samzhou2 Oct 8, 2024
948928d
Update redirects
samzhou2 Oct 8, 2024
7a1c4e3
updated url
samzhou2 Oct 8, 2024
40e385a
Update antora-playbook.yml
samzhou2 Oct 8, 2024
11b298a
Update change
samzhou2 Oct 10, 2024
cd1cbfe
update
samzhou2 Oct 10, 2024
ffc281d
Merge branch 'main' into cloud-dev
samzhou2 Oct 21, 2024
6a025c1
Updateed the order
samzhou2 Oct 25, 2024
5171f40
update
samzhou2 Oct 27, 2024
17a65b7
Update
samzhou2 Oct 27, 2024
93c8cb2
update antora playbook
samzhou2 Oct 27, 2024
cce6200
update
samzhou2 Oct 27, 2024
138f770
Merge branch 'main' into cloud-dev
samzhou2 Oct 27, 2024
7574a87
Update branch names for server, gsql, gui, and insights
victorleeTG Oct 28, 2024
d321793
add mailto
linyutg Oct 30, 2024
00b3ac7
Merge pull request #71 from linyutg/cloud-dev
victorleeTG Oct 30, 2024
fa1ba53
Add GA release time
samzhou2 Nov 4, 2024
50feb3d
Add redirects
samzhou2 Nov 4, 2024
652394d
Merge branch 'main' into cloud-dev
samzhou2 Nov 4, 2024
289f928
Add beta back
samzhou2 Nov 6, 2024
4a82950
touch file to force build
victorleeTG Nov 7, 2024
fd7c9e9
Merge branch 'main' into cloud-dev
samzhou2 Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,24 @@ content:
# What branch, main or some staging, e.g. cloud-dev?
sources:
- url: https://github.com/tigergraph/doc-site.git
branches: [main]
branches: [cloud-dev]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samzhou2 I can't let you push this into the main branch of doc-site. We never want to change this line in the production branch.

What you should do is get the https://cloud-dev--docs-tigergraph.netlify.app/home/ site fully polished, then when you want to publish to main, we can work on that together.

If you are based on a current version of antora-playbook.yml, then I maybe only 2 lines need to change:

  • start_paths: [modules/cloud, modules/cloudbeta]
  • age-component-order: '!home, tigergraph-server, gsql-ref, cloud, cloudbeta, cloudBeta, gui, insights, graph-ml, pytigergraph, ml-workbench, graphql, tg-copilot'

If you have antora-ui changes, rather than having the main doc-site point to your cloud-dev branch of antorai-ui, you should merge your antori-ui updates to main. Yes, you have to coordinate the merges of two different repos, and we have to be confident that it will work.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will not push this change, I leave it here in the PR was because maily want to have a preview site available, so that everyone else can review the docs at https://deploy-preview-68--docs-tigergraph.netlify.app/cloud4/main/overview/

#- url: https://github.com/tigergraph/doc-site.git
# branches: [staging]

# (3) Purpose: What is the content: remote or local?
# What versions (Previews will usually have extra versions).
start_paths: home
- url: https://github.com/tigergraph/cloud-docs.git
branches: [main]
start_paths: [modules/cloud, modules/cloudbeta]
branches: [dev]
start_paths: [modules/cloud, modules/cloud4]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samzhou2 So I assume you doing a simple rename of the module cloud-docs/cloudbeta to cloud-docs/cloud4 and/or changing the name(?) property in the antora.yml file?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added redirects from cloudbeta to cloud4

- url: https://github.com/tigergraph/server-docs.git
branches: [3.6, 3.9.3, 3.10.1, 3.11.0, 4.1.o]
branches: [3.6, 3.9, "3.10", 3.11, 4.1]
- url: https://github.com/tigergraph/gsql-docs.git
branches: [3.6, 3.9.3, 3.10.1, 3.11.0, 4.1.o]
branches: [3.6, 3.9, "3.10", 3.11, 4.1]
- url: https://github.com/tigergraph/gui-docs.git
branches: [3.6, 3.9.3, 3.10.1, 3.11.0, 4.1.o]
branches: [3.6, 3.9, "3.10", 3.11, 4.1]
- url: https://github.com/tigergraph/insights-docs
branches: [3.9.3, 3.10.1, 3.11.0, 4.1.o]
branches: [3.6, 3.9, "3.10", 3.11, 4.1]
- url: https://github.com/tigergraph/tigdsl-docs.git
branches: ["3.10"]
- url: https://github.com/tigergraph/tigergraphql.git
Expand All @@ -64,12 +64,12 @@ content:
branches: [main]
ui:
bundle:
url: https://github.com/tigergraph/antora-ui/blob/main/build/ui-bundle.zip?raw=true
url: https://github.com/tigergraph/antora-ui/blob/cloud-dev/build/ui-bundle.zip?raw=true
#url: /Users/victorlee/Documents/GitHub1/Docs/antora-ui/build/ui-bundle.zip?raw=true
snapshot: true
asciidoc:
attributes:
page-component-order: '!home, tigergraph-server, gsql-ref, cloud, cloudbeta, cloudBeta, gui, insights, graph-ml, pytigergraph, ml-workbench, graphql, tg-copilot'
page-component-order: '!home, tigergraph-server, gsql-ref, cloud4, gui, insights, graph-ml, pytigergraph, ml-workbench, graphql, tg-copilot, cloud'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samzhou2 I would not put the legacy cloud at the end. I think you should group the two versions of cloud together. Instead, I would change the title property of the original cloud from "TigerGraph Cloud" to "TigerGraph Cloud 3 (Classic)" or something like that.

I actually want some UI coding help to divide the menu into 3 parts:

  1. DB and GSQL (by far the most popular part of the documentation)
  2. Cloud
  3. Tools, both UI and Data Science

extensions:
- ./libs/tabs-block.js
urls:
Expand Down
11 changes: 5 additions & 6 deletions home/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
:navtitle: home
:page-role: home


====
* xref:3.11@tigergraph-server:release-notes:index.adoc[TigerGraph Server 3.11.0 Preview] was released on Oct 25, 2024.

* xref:3.10@tigergraph-server:release-notes:index.adoc#_fixed_and_improved_in_3_10_2[TigerGraph Server 3.10.2] was released on Oct 18, 2024.

* xref:4.1@tigergraph-server:release-notes:index.adoc[TigerGraph Server 4.1.0 Preview] was released on Aug. 30, 2024.

* xref:cloudBeta:overview:index.adoc[TigerGraph Cloud 4.0 beta] was released on Apr. 29, 2024.
* xref:cloud4:overview:index.adoc[TigerGraph Cloud 4] was released on Apr. 29, 2024.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samzhou2 You should not rewrite history.
TigerGraph Cloud 4.0 Beta WAS published on Apr 29, 2024. It was Beta in April.

Rather than changing history, you should announcement the new release of TG Cloud 4.1 (?)
We are moving all the historical items to the bottom of the page.
Currently, we have zero announcements at the top, but I think we can have one latest announcement at the top.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added "beta" back, but we will need to change the URL since when we release cloud GA, beta docs will no longer available and should be removed. Added redirect rules for beta to direct to cloud4 overview page


Click here to see other xref:index.adoc#_announcements[]!
====
Expand All @@ -33,9 +32,9 @@ image:cloudIcon-homecard.png[alt=TigerGraphCloud,width=74,height=74]

A fully-managed cloud database built on the fast and highly scalable TigerGraph Enterprise Server engine.

xref:cloud:start:overview.adoc[TigerGraph Cloud] |
xref:cloud:start:get_started.adoc[Get Started] |
xref:cloudBeta:overview:index.adoc[TigerGraph Cloud 4.0]
xref:cloud4:overview:index.adoc[TigerGraph Cloud 4] |
xref:cloud4:get-started:index.adoc[Get Started] |
xref:cloud:start:overview.adoc[TigerGraph Cloud Classic]

¦
image:tg_suites-homecard.png[alt=TigerGraphSuite,width=74,height=74]
Expand Down Expand Up @@ -87,7 +86,7 @@ Recent News and Releases
====
* xref:1.7@pytigergraph:release-notes:index.adoc[pyTigerGraph 1.7] was released on Aug. 21, 2024.
* xref:tg-copilot:intro:index.adoc[CoPilot 0.9] was released on Aug. 19, 2024.
* xref:cloudBeta:overview:index.adoc[TigerGraph Cloud 4.0] - TigerGraph Cloud 4.0 beta version was released on Apr. 29, 2024.
* xref:cloud4:overview:index.adoc[TigerGraph Cloud 4.0] - TigerGraph Cloud 4.0 beta version was released on Apr. 29, 2024.
//* xref:1.6@pytigergraph:release-notes:index.adoc[pyTigerGraph 1.6] was released on Apr. 29, 2024.
//* xref:tigergraph-server:release-notes:index.adoc[TigerGraph 3.10.0] preview version was released on Mar. 13, 2024.
* xref:3.9@tigergraph-server:release-notes:index.adoc#_fixed_and_improved_in_3_9_3_3[TigerGraph 3.9.3-3] was released on Feb. 15, 2024.
Expand Down
10 changes: 5 additions & 5 deletions netlify.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[[headers]]
for = "/*"
[headers.values]
Content-Security-Policy = "default-src * 'unsafe-inline' 'unsafe-eval'; script-src * 'unsafe-inline' 'unsafe-eval' https://cdnjs.cloudflare.com; connect-src * 'unsafe-inline'; img-src * data: blob: 'unsafe-inline'; frame-src *; style-src * 'unsafe-inline';"
Content-Security-Policy = "default-src * 'unsafe-inline' 'unsafe-eval'; script-src * 'unsafe-inline' 'unsafe-eval' https://cdnjs.cloudflare.com; connect-src * 'unsafe-inline'; img-src * data: blob: 'unsafe-inline'; frame-src * mailto: ; style-src * 'unsafe-inline';"
X-Content-Type-Options = "nosniff"
X-Frame-Options = "DENY"

Expand Down Expand Up @@ -46,17 +46,17 @@
to = "/cloud/current/start/get_started"

[[redirects]]
from = "/cloudbeta/overview"
to = "/cloudbeta/current/overview"
from = "/cloud4/overview"
to = "/cloud4/current/overview"

# cloud and cloudbeta- general redirect from "current" to "main"
[[redirects]]
from = "/cloud/current/*"
to = "/cloud/main/:splat"

[[redirects]]
from = "/cloudbeta/current/*"
to = "/cloudbeta/main/:splat"
from = "/cloud4/current/*"
to = "/cloud4/main/:splat"

# redirects for language reference
[[redirects]]
Expand Down