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.

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

wants to merge 30 commits into from

Conversation

samzhou2
Copy link

No description provided.

Copy link

netlify bot commented Oct 27, 2024

Deploy Preview for docs-tigergraph ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/docs-tigergraph/deploys/6768b469510dde4459109719
😎 Deploy Preview https://deploy-preview-68--docs-tigergraph.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@victorleeTG victorleeTG changed the title DOC-2118 feat(tgclouv4): Cloud v4 Docs; DOC-2118 feat(tgcloud4): Cloud v4 Docs; Oct 28, 2024
#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

@@ -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/

====
* 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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants