Skip to content

Commit

Permalink
Updating Viridian -> Cloud (#149)
Browse files Browse the repository at this point in the history
* Updating Viridian -> Cloud

Catching instances of Viridian in the cloud repo that are not covered by the variable update

* Renamed sql_basics_on_viridian Tutorial

Hendy has confirmed that she will rename this file, so links are now updated to match

* Final updates

catching file name change

* HZC-6745: Fix dead links

---------

Co-authored-by: Eugene Abramchuk <[email protected]>
  • Loading branch information
rebekah-lawrence and abramche authored Feb 28, 2024
1 parent c266f00 commit d4336a1
Show file tree
Hide file tree
Showing 12 changed files with 56 additions and 41 deletions.
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Hazelcast Viridian Documentation
= Hazelcast Cloud Documentation
// Settings:
ifdef::env-github[]
:warning-caption: :warning:
Expand All @@ -13,7 +13,7 @@ endif::[]

image:https://img.shields.io/badge/Build-Staging-yellow[link="{url-staging}"]

This repository contains the Antora components for the Hazelcast Viridian documentation.
This repository contains the Antora components for the Hazelcast Cloud documentation.

The documentation source files are marked up with AsciiDoc.

Expand Down
8 changes: 4 additions & 4 deletions antora-playbook-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ content:
- url: https://github.com/hazelcast-guides/standard-deviation-parallel-processing
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/sql_basics_on_viridian
- url: https://github.com/hazelcast-guides/cloud
branches: master
start_paths: docs
- url: https://github.com/hazelcast/hazelcast-cloud-maven-plugin
Expand All @@ -56,9 +56,9 @@ asciidoc:
page-pagination: true
idprefix: ''
idseparator: '-'
hazelcast-cloud: Viridian Cloud
page-cloud-console: https://viridian.hazelcast.com/
page-cloud-signup: https://viridian.hazelcast.com/sign-up
hazelcast-cloud: Cloud
page-cloud-console: https://cloud.hazelcast.com/
page-cloud-signup: https://cloud.hazelcast.com/sign-up
extensions:
- ./lib/tabs-block.js
- asciidoctor-kroki
8 changes: 4 additions & 4 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ content:
- url: https://github.com/hazelcast-guides/standard-deviation-parallel-processing
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/sql_basics_on_viridian
- url: https://github.com/hazelcast-guides/sql_stock_ticker_cloud
branches: master
start_paths: docs
- url: https://github.com/hazelcast/hazelcast-cloud-maven-plugin
Expand All @@ -54,9 +54,9 @@ asciidoc:
page-pagination: true
idprefix: ''
idseparator: '-'
hazelcast-cloud: Viridian Cloud
page-cloud-console: https://viridian.hazelcast.com/
page-cloud-signup: https://viridian.hazelcast.com/sign-up
hazelcast-cloud: Cloud
page-cloud-console: https://cloud.hazelcast.com/
page-cloud-signup: https://cloud.hazelcast.com/sign-up
extensions:
- ./lib/tabs-block.js
- asciidoctor-kroki
8 changes: 4 additions & 4 deletions check-links-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ content:
- url: https://github.com/hazelcast/hz-docs
branches: [main, v/*]
start_path: docs
- url: https://github.com/hazelcast-guides/sql_basics_on_viridian
- url: https://github.com/hazelcast-guides/sql_stock_ticker_cloud
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/stream-to-stream-joins
Expand Down Expand Up @@ -57,9 +57,9 @@ asciidoc:
page-pagination: true
idprefix: ''
idseparator: '-'
hazelcast-cloud: Viridian Cloud
page-cloud-console: https://viridian.hazelcast.com/
page-cloud-signup: https://viridian.hazelcast.com/sign-up
hazelcast-cloud: Cloud
page-cloud-console: https://cloud.hazelcast.com/
page-cloud-signup: https://cloud.hazelcast.com/sign-up
extensions:
- ./lib/tabs-block.js
- asciidoctor-kroki
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ asciidoc:
page-cloud-platform-version: 5.3
page-cloud-console: https://cloud.hazelcast.com/
page-cloud-signup: https://cloud.hazelcast.com/sign-up
full-version: '5.3.6'
full-version: '5.4.0'
nav:
- modules/ROOT/nav.adoc
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/connect-to-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: To communicate with a cluster, you need a client. Hazelcast offers clients in a variety of languages as well as a command-line client for quick prototyping and scripting.
:page-aliases: connect-to-private-cluster.adoc
:cloud-tags: Develop Applications | Manage Clusters
:cloud-title: Connecting to Viridian Cloud Clusters | Connecting to Clusters
:cloud-title: Connecting to Cloud Clusters | Connecting to Clusters
:cloud-order: 21 | 50

{description}
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/create-account.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
= Create an Account
:description: You must create an account before you can use {hazelcast-cloud}. Creating an account creates an organization with a single user. You can sign up using an email address and password, or with a GitHub or Google account.
:description: You must create an account before you can use {hazelcast-cloud}. Creating an account creates an organization with a single user. You can sign up using an email address and password, or with a GitHub or Google account to use our Standard or Trial editions.
:toclevels: 3

{description}

Whichever sign-up method you use, you are given the choice of creating a free Trial account, or a paid Viridian Standard account. For further information on the available {hazelcast-cloud} editions, see the xref:overview.adoc[Hazelcast {hazelcast-cloud}] section.
Whichever sign-up method you use, you are given the choice of creating a free Trial account, or a paid {hazelcast-cloud} Standard account. If you would prefer not to share infrastructure with other customers, you can set up a Dedicated account directly with Hazelcast. For further information on the available {hazelcast-cloud} editions, see the xref:overview.adoc[Hazelcast {hazelcast-cloud}] section.

NOTE: By creating an account, you are agreeing to the {hazelcast-cloud} link:https://viridian.hazelcast.com/terms-of-service[Terms of Service,window=_blank] and the Hazelcast link:https://hazelcast.com/privacy/[Privacy Policy,window=_blank]. These documents are also available from the sign-up page.
NOTE: By creating an account, you are agreeing to the {hazelcast-cloud} link:https://cloud.hazelcast.com/terms-of-service[Terms of Service,window=_blank] and the Hazelcast link:https://hazelcast.com/privacy/[Privacy Policy,window=_blank]. These documents are also available from the sign-up page.

To create an account, complete the following steps:
To create a Standard account, complete the following steps:

. Open the link:{page-cloud-signup}[{hazelcast-cloud} sign-up page, window=_blank]

Expand Down
19 changes: 14 additions & 5 deletions docs/modules/ROOT/pages/free-trial.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
= {hazelcast-cloud} Trial
:description: Explore the capabilities of Viridian Cloud Standard with a 14-day trial.
:description: Explore the capabilities of Hazelcast Cloud Standard with a free 14-day trial.

{description}

Start your trial by signing up for a link:{page-cloud-console}[{hazelcast-cloud} account, window=_blank].

== What Can I Do During My Trial?

Your trial gives you access to a fully functional Hazelcast environment. During the trial, you can use all the features of a single development cluster. You can also connect to the cluster using one of the preconfigured sample clients: Java, Python, .NET, or (CLC) CLI.
Your trial gives you access to the Hazelcast environment, with an optional guided tour to get you started.

During your trial, you can use all the features of a single development cluster. You can connect to the cluster using the preconfigured Java, Python, .NET, or (CLC) CLI sample clients, or you can use our advanced client setup guide to configure your own client.

Development clusters have certain limitations as they are designed for fast, iterative prototyping. These include:

Expand All @@ -20,9 +22,9 @@ Development clusters have certain limitations as they are designed for fast, ite

NOTE: When a development cluster restarts for any reason, you lose all cluster data, such as maps and cluster-side modules.

== Is Any Support Available During the Free Trial?
== Is Any Support Available?

You can get support from our team at any point during your trial by sending an email to mailto:viridian@hazelcast.com[].
You can get support from our team at any point during your trial by sending an email to mailto:cloud@hazelcast.com[].

You'll also receive emails from Hazelcast with useful resources to help you get up and running with your first cluster.

Expand All @@ -31,4 +33,11 @@ You'll also receive emails from Hazelcast with useful resources to help you get
At the end of the 14-day trial period, two things happen:

- Your account is automatically suspended. This means that although you can still access the trial environment, your cluster is stopped and cannot be restarted.
- Your trial environment, including all data, will be automatically deleted.
- Your trial environment, including all data, is automatically deleted.

Hazelcast will be in touch during your trial, and when it ends. If you want to talk further with us about subscription options, mailto:[email protected][send us an email], or select the button available at the end of most trial communications from Hazelcast.

You can find out more about the subscripton options in the following topics:

* xref:serverless-cluster.adoc[]. This is the pay-as-you-go subscription option
* xref:dedicated-cluster.adoc[]. This is our contractual subscription option
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/imap-connections.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Creating Mappings to IMaps
:description: To run a SQL query against data in an IMap on a Viridian Cloud cluster, you need to create a mapping. The easiest way to do this is to use the connector wizard.
:description: To run a SQL query against data in an IMap on a Hazelcast Cloud cluster, you need to create a mapping. The easiest way to do this is to use the connector wizard.
:cloud-tags: Develop Applications
:cloud-title: Creating Mappings to IMaps
:cloud-order: 70
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/jdbc-sample-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ Connect your JDBC client to your {hazelcast-cloud} cluster using the following U

[source]
----
jdbc:hazelcast://<cluster-id>/?discoveryToken=<yourDiscoveryToken>&cloudUrl=https://api.viridian.hazelcast.com&sslEnabled=true
jdbc:hazelcast://<cluster-id>/?discoveryToken=<yourDiscoveryToken>&cloudUrl=https://api.cloud.hazelcast.com&sslEnabled=true
----

This can be understood as follows:

* `jdbc:hazelcast` A required sub-protocol. This is a constant
* `<cluster-id>` The ID of your cluster as displayed at the top right of the *Cluster Details* in the dashboard for the cluster in your link:{page-cloud-console}[{hazelcast-cloud} console,window=_blank]
* `discoveryToken` Set this to the discovery token created with your cluster. To find your discovery token select *CONNECT CLUSTER*. The discovery token can be revealed using the *Advanced setup* tab
* `cloudURL` This must be set to the API base URL, `\https://api.viridian.hazelcast.com`. As TLS is mandatory, you must also enable SSL by appending `&sslEnabled=true` to the cloud URL
* `cloudURL` This must be set to the API base URL, `\https://api.cloud.hazelcast.com`. As TLS is mandatory, you must also enable SSL by appending `&sslEnabled=true` to the cloud URL

For further information on the connection properties used by the Hazelcast JDBC driver, refer to the https://github.com/hazelcast/hazelcast-jdbc/blob/main/README.md[READ ME^] file.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/migrate-to-cloud.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Exceeding these limits can lead to cluster failure.
Be aware that the following operations use heap memory: writing, caching, or replicating data to data structures other than IMap an JCache.
See xref:serverless-cluster.adoc#heap-memory-limits-of-viridian-serverless-clusters[Heap Memory Limits of {hazelcast-cloud} Standard Clusters] for further details.
For further information on {hazelcast-cloud} Standard clusters and their limits, see xref:serverless-cluster.adoc[].
====

- [ ] Remove member configuration from your code. Hazelcast configures the cluster for the best possible performance. All you need to do is configure the client and any data structures.
Expand Down
30 changes: 18 additions & 12 deletions docs/modules/ROOT/pages/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
:description: Hazelcast {hazelcast-cloud} simplifies deployments of Hazelcast Platform to the cloud. Hazelcast manages the underlying infrastructure allowing you to focus on building applications for stream and batch processing, low-latency querying, and caching.
:page-aliases: use-cases.adoc, faq.adoc, pricing.adoc, preface.adoc, wan-replication.adoc, support.adoc
:cloud-tags: Get Started
:cloud-title: Hazelcast Viridian Cloud Overview
:cloud-title: Hazelcast Cloud Overview
:cloud-order: 10

{description}

Hazelcast {hazelcast-cloud} abstracts away the manual effort of managing physical servers or servers in the cloud so that you can focus on what matters: Building your application.
Hazelcast {hazelcast-cloud} eliminates the manual effort of managing physical servers or servers in the cloud so that you can focus on what matters: building your application.

== Application Topology

Expand All @@ -19,29 +19,35 @@ Hazelcast {hazelcast-cloud} abstracts away the manual effort of managing physica

== Editions

Hazelcast {hazelcast-cloud} has two editions: {hazelcast-cloud} Standard and {hazelcast-cloud} Dedicated.

xref:free-trial.adoc[{hazelcast-cloud} Trial] offers the capabilities of {hazelcast-cloud} Standard for a 14-day trial period.

Hazelcast {hazelcast-cloud} offers the choice of two editions:

[cols="1a,2a"]
|===
|Edition|Description

|xref:serverless-cluster.adoc[{hazelcast-cloud} Standard]
|{hazelcast-cloud} Standard
|{hazelcast-cloud} Standard clusters auto-scale, depending on the amount of data you store.

|xref:dedicated-cluster.adoc[{hazelcast-cloud} Dedicated]
|To maximize security whilst minimizing latency, {hazelcast-cloud} Dedicated clusters expose only private Hazelcast endpoints. For consistent performance and throughput, {hazelcast-cloud} Dedicated clusters do not share infrastructure with any other customers.
|{hazelcast-cloud} Dedicated
|To maximize security whilst minimizing latency, {hazelcast-cloud} Dedicated clusters expose only private Hazelcast endpoints. For consistent performance and throughput, {hazelcast-cloud} Dedicated clusters do not share infrastructure with any other customers.
|===

NOTE: When you first create an account on Hazelcast {hazelcast-cloud}, you become the administrator of an organization. For Trial Edition users, this has no further impact. For Standard and Dedicated Edition users, this means that you can invite users to your organization and share resources, such as clusters. For further information on organizations, see the xref:organizations-and-accounts.adoc[Organizations and Accounts] section.

== Getting Started

If you are a first-time user of Hazelcast {hazelcast-cloud}, see xref:get-started.adoc[].
Find out more about the Hazelcast {hazelcast-cloud} editions:

* xref:serverless-cluster.adoc[{hazelcast-cloud} Standard]
* xref:dedicated-cluster.adoc[{hazelcast-cloud} Dedicated]

Try {hazelcast-cloud} for 14 days with no cost or commitment with the xref:free-trial.adoc[{hazelcast-cloud} Trial].

== Next Steps

If you are a first-time user of Hazelcast {hazelcast-cloud}, follow the xref:get-started.adoc[] tutorial.

If you're ready to get started with a real use case, see xref:tutorials.adoc[].
If you're ready to get started with real use cases, follow our other xref:tutorials.adoc[tutorials].

If you want to get an overview of the use cases and advantages of Hazelcast {hazelcast-cloud}, see the link:https://hazelcast.com/products/cloud/[Hazelcast website].
If you want an overview of the use cases and advantages of Hazelcast {hazelcast-cloud}, see the link:https://hazelcast.com/products/cloud/[Hazelcast website].

0 comments on commit d4336a1

Please sign in to comment.