DOCS-689 Viridian Organization Documentation #140

rebekah-lawrence · 2023-11-23T15:13:49Z

Updates to navigation, playbooks, and existing, re-used, topics as well as new files for the details

rebekah-lawrence · 2024-01-03T14:52:38Z

docs/modules/ROOT/pages/user-roles.adoc

+* xref:invite-user.adoc[Invite user]
+* xref:remove-user.adoc[Delete user]
+* xref:payment-methods.adoc[Manage billing and payments]
+* xref:delete-account.adoc[Delete the organization account]


need to add information on what the user type sees; for example the admin user sees all clusters, org users see only their own clusters. Also, that there is a delay between an update - for example if the org user changes their name - and that change being visible for the admin user

rebekah-lawrence · 2024-01-03T15:29:55Z

docs/modules/ROOT/pages/delete-account.adoc

 :cloud-order: 60
 :toclevels: 3

 {description}

+You cannot delete an organization while there are outstanding payments on the account.


Suggested change

You cannot delete an organization while there are outstanding payments on the account.

You cannot delete an organization while there are outstanding payments on the account. However, if a payment method is associated with the account, the outstanding payment is processed automatically and the organization is then deleted.

rebekah-lawrence · 2024-01-11T13:09:21Z

docs/modules/ROOT/pages/delete-account.adoc


-== Deleting your Account
+. Open the link:{page-cloud-console}[Hazelcast {hazelcast-cloud} console,window=_blank].
+. Select *Account* from the side navigation bar


I believe the option to delete the org is moving to the more logical position in the Organization options.

We have https://hazelcast.atlassian.net/browse/HZC-6274 to address this

docs/modules/ROOT/pages/accept-invitation.adoc

docs/modules/ROOT/pages/create-account.adoc

docs/modules/ROOT/pages/create-budget-tracker.adoc

docs/modules/ROOT/pages/invite-user.adoc

docs/modules/ROOT/pages/remove-user.adoc

docs/modules/ROOT/pages/user-mfa-settings.adoc

docs/modules/ROOT/pages/user-roles.adoc

Also added information on the need to reset password before MFA can be enabled if not already set.

hz-aborovenskyi · 2024-01-18T08:11:33Z

docs/modules/ROOT/pages/add-payment-method.adoc

@@ -0,0 +1,42 @@
+== Add Payment Method
+:description: {hazelcast-cloud} Standard Edition admin users are prompted to add payment details after signing in for the first time. Adding your payment details sets up automatic payments based on your usage. You cannot create clusters until you have added a payment card.


admin users are prompted to add payment details after signing in for the first time

@rebekah-lawrence admin users are also prompted to add payment details just before they try to create their first cluster. Maybe this is smth we have to mention, not sure though

hz-aborovenskyi · 2024-01-18T08:14:04Z

docs/modules/ROOT/pages/add-payment-method.adoc

+
+NOTE: {hazelcast-cloud} Trial Edition users do not need to add payment details. The payment details for {hazelcast-cloud} Dedicated Edition users are agreed and set up as part of account creation.
+
+To add your payment details, complete the following steps:


pls see ther comment above regarding the alternative way of adding the payment details

hz-aborovenskyi · 2024-01-18T08:52:25Z

docs/modules/ROOT/pages/create-account.adoc


-To create a new account, go to the link:{page-cloud-console}[{hazelcast-cloud} sign-up page, window=_blank].
+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 vailable from the sign-up page.  


typo: vailable :)

hz-aborovenskyi · 2024-01-18T08:55:01Z

docs/modules/ROOT/pages/create-account.adoc

-. Sign into Google if you haven't already.
+NOTE: If you use this method, you do not create a {hazelcast-cloud} password. If you subsequently want to sign in with your email and use MFA in {hazelcast-cloud}, you must set a password first. For further information on setting a password, see the xref:change-password.adoc[] topic.
+
+. Select the *Google* button


@rebekah-lawrence we also have "Github" button for social sign in. JFYI

The GitHub option should be there as a tab, is this not what you are seeing?

[Note that, Karthic's request, the next update will reorder these tabs to Email | GitHub | Google]

hz-aborovenskyi · 2024-01-18T08:56:51Z

docs/modules/ROOT/pages/create-account.adoc


-A confirmation email will be sent to your registered email address and you will be signed into the {hazelcast-cloud} console.
+A confirmation email is sent to your registered email address and the {hazelcast-cloud} console displays the Cluster screen ready for you to continue. 


A confirmation email is sent to your registered email

it's not sent in case of social login

hz-aborovenskyi · 2024-01-18T09:37:31Z

docs/modules/ROOT/pages/serverless-cluster.adoc

@@ -10,6 +10,8 @@

 Standard means that Hazelcast manages the cloud infrastructure for you. Each {hazelcast-cloud} Standard cluster is an independent deployment of Hazelcast Platform in a Kubernetes container. This design guarantees resource isolation, prevents resource stealing, and provides isolated network access.

+When you first create an account on Hazelcast {hazelcast-cloud}, you become the admin user for an organisation. 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.


another place of using organisation and organization in the same sentence :)

hz-aborovenskyi · 2024-01-18T09:43:51Z

docs/modules/ROOT/pages/organizations-and-accounts.adoc

@@ -0,0 +1,21 @@
+= Overview
+:description: An Organization account allows one or more users to use shared resources, such as clusters. Every account is owned by an organization and is controlled by an admin user. Up to 100 associated organization users can be added. Users can belong to a single organization organization only.


Up to 100 associated organization users can be added

TBH, we don't have this implemented, I've raised https://hazelcast.atlassian.net/browse/HZC-6371 to address this

removed org user limit until JIRA implemented

hz-aborovenskyi · 2024-01-18T09:49:11Z

docs/modules/ROOT/pages/user-roles.adoc

+
+Admin users can see all clusters. If an organization user is removed, the admin user inherits ownership of the related clusters and resources.
+
+When updates are made, for example to the state of a cluster or to an organization user's name, there is be a delay between the change being made and the view presented to the admin user.


there is be

maybe a typo?

I'd also state something more optimistic, say, "there might be a delay" :)

That's because I originally had might be and changed it. Changed back!

hz-aborovenskyi · 2024-01-18T09:50:49Z

docs/modules/ROOT/pages/users.adoc

+* View and update their profile. For further information on updating your profile, see the xref:view-and-update-profile.adoc[View and Update Profile] topic
+* If MFA has not been enforced at organization-level, enable and disable MFA on their account. For further information on enabling and disabling MFA for your sign in, see the xref:user-mfa-settings.adoc[User MFA Settings] topic
+* Generate, copy, and delete an API key. For further information on the API key, see the xref:manage-api-key.adoc[Manage API Key] topic
+* Change the password used to sign in to their account. For further information on changing the password associated with yuor sign in, see the xref:change-password.adoc[Change Password] topic


yuor

typo :)

hz-aborovenskyi · 2024-01-18T09:53:16Z

docs/modules/ROOT/partials/create-api-key.adoc

+After creating your credentials, ensure that you applications are correctly configured to use the API credentials.
+// end::create[]
+
+IMPORTANT: Keep your keys and secrets secure. Anyone who has these credentials can delete your clusters.


Not only delete clusters, but do anything. JFYI

I have brought the docs into line with the current product (MFA enforcement, user limit) and rejigged the payments information to remove the separate Add Payment Method topic and merge the information into the Create Account topic. I've also given it a good read-through, caught some interface changes, ensured any wording changes from the review are applied where applicable, and all that jazz.

alaktionov · 2024-01-19T14:57:57Z

docs/modules/ROOT/pages/add-payment-method.adoc

+
+{description}
+
+NOTE: {hazelcast-cloud} Trial Edition users do not need to add payment details. The payment details for {hazelcast-cloud} Dedicated Edition users are agreed and set up as part of account creation.


Not sure if we actually have Dedicated Edition users. Perhaps we don't need this sentence at all The payment details for {hazelcast-cloud} Dedicated Edition users are agreed and set up as part of account creation.? It adds more questions than answers.

alaktionov · 2024-01-19T15:08:43Z

docs/modules/ROOT/pages/add-payment-method.adoc

+.. Optionally, add the second line of your address in the *Address Line 2 (Optional)* text box
+.. Enter your country in the *Country* text box
+.. Enter the city used in your address in the *City* text box
+.. Enter your post, or zip, code in the *Postal Code* text box


Suggested change

.. Enter your post, or zip, code in the *Postal Code* text box

.. Enter your post, or zip code in the *Postal Code* text box

alaktionov · 2024-01-19T15:33:24Z

docs/modules/ROOT/pages/dedicated-cluster.adoc

It's quite strange that we still have this page in docs. We don't support dedicated clusters/users in the way it's described here. I would hide the entire page from the DOCS (and all related pages) and search for all Dedicated related words in the Viridian Cloud documentation to clean that up. But @kthope could confirm on that.

alaktionov · 2024-01-19T15:39:56Z

docs/modules/ROOT/pages/manage-api-key.adoc

+
+{description}
+
+When you generate your API key, you can copy it directly from the Hazelcast {hazelcast-cloud} console.


Perhaps it would make sense to add a note with recommendation to save it now, because later on API secret will be hidden and user will see only API Key

removed "you can" from this sentence - and added a TIP to the Copy section with the extra information.

DOCS-689 Viridian Organization Documentation

34d1bda

Updates to navigation, playbooks, and existing, re-used, topics as well as new files for the details

rebekah-lawrence requested review from abramche and Serdaro November 23, 2023 15:22

Serdaro approved these changes Nov 28, 2023

View reviewed changes

rebekah-lawrence commented Jan 3, 2024

View reviewed changes

alaktionov self-requested a review January 11, 2024 12:29

rebekah-lawrence commented Jan 11, 2024

View reviewed changes

rebekah-lawrence requested a review from hz-aborovenskyi January 11, 2024 13:12

abramche reviewed Jan 12, 2024

View reviewed changes

Updated from Eugene's review

e9f396d

Also added information on the need to reset password before MFA can be enabled if not already set.

rebekah-lawrence requested a review from abramche January 17, 2024 17:20

hz-aborovenskyi approved these changes Jan 18, 2024

View reviewed changes

alaktionov reviewed Jan 19, 2024

View reviewed changes

Updated from Artem's review

b022b72

abramche approved these changes Jan 22, 2024

View reviewed changes

alaktionov approved these changes Jan 22, 2024

View reviewed changes

rebekah-lawrence merged commit 5f04960 into main Jan 25, 2024
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-689 Viridian Organization Documentation #140

DOCS-689 Viridian Organization Documentation #140

rebekah-lawrence commented Nov 23, 2023

rebekah-lawrence Jan 3, 2024 •

edited

Loading

rebekah-lawrence Jan 3, 2024

rebekah-lawrence Jan 11, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

rebekah-lawrence Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

rebekah-lawrence Jan 19, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

rebekah-lawrence Jan 19, 2024

hz-aborovenskyi Jan 18, 2024

hz-aborovenskyi Jan 18, 2024

alaktionov Jan 19, 2024

alaktionov Jan 19, 2024

alaktionov Jan 19, 2024

alaktionov Jan 19, 2024

rebekah-lawrence Jan 19, 2024

	You cannot delete an organization while there are outstanding payments on the account.
	You cannot delete an organization while there are outstanding payments on the account. However, if a payment method is associated with the account, the outstanding payment is processed automatically and the organization is then deleted.

		@@ -0,0 +1,42 @@
		== Add Payment Method
		:description: {hazelcast-cloud} Standard Edition admin users are prompted to add payment details after signing in for the first time. Adding your payment details sets up automatic payments based on your usage. You cannot create clusters until you have added a payment card.


		NOTE: {hazelcast-cloud} Trial Edition users do not need to add payment details. The payment details for {hazelcast-cloud} Dedicated Edition users are agreed and set up as part of account creation.

		To add your payment details, complete the following steps:


		To create a new account, go to the link:{page-cloud-console}[{hazelcast-cloud} sign-up page, window=_blank].
		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 vailable from the sign-up page.


		A confirmation email will be sent to your registered email address and you will be signed into the {hazelcast-cloud} console.
		A confirmation email is sent to your registered email address and the {hazelcast-cloud} console displays the Cluster screen ready for you to continue.

		@@ -10,6 +10,8 @@

		Standard means that Hazelcast manages the cloud infrastructure for you. Each {hazelcast-cloud} Standard cluster is an independent deployment of Hazelcast Platform in a Kubernetes container. This design guarantees resource isolation, prevents resource stealing, and provides isolated network access.

		When you first create an account on Hazelcast {hazelcast-cloud}, you become the admin user for an organisation. 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.

		@@ -0,0 +1,21 @@
		= Overview
		:description: An Organization account allows one or more users to use shared resources, such as clusters. Every account is owned by an organization and is controlled by an admin user. Up to 100 associated organization users can be added. Users can belong to a single organization organization only.


		Admin users can see all clusters. If an organization user is removed, the admin user inherits ownership of the related clusters and resources.

		When updates are made, for example to the state of a cluster or to an organization user's name, there is be a delay between the change being made and the view presented to the admin user.


		{description}

		NOTE: {hazelcast-cloud} Trial Edition users do not need to add payment details. The payment details for {hazelcast-cloud} Dedicated Edition users are agreed and set up as part of account creation.

	.. Enter your post, or zip, code in the Postal Code text box
	.. Enter your post, or zip code in the Postal Code text box


		{description}

		When you generate your API key, you can copy it directly from the Hazelcast {hazelcast-cloud} console.

DOCS-689 Viridian Organization Documentation #140

DOCS-689 Viridian Organization Documentation #140

Conversation

rebekah-lawrence commented Nov 23, 2023

rebekah-lawrence Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rebekah-lawrence Jan 3, 2024 •

edited

Loading