Align docs with MC 5.4.0 #305

emrberk · 2024-03-12T17:53:40Z

Screenshots are updated with rebranding.
Top Bar and Side Bar updates are added.
License pages are updated.
Some tables are updated.
Removed legacy features.
Removed screenshots about legacy features.

netlify · 2024-03-12T17:53:59Z

✅ Deploy Preview for frosty-curran-1fc0c4 ready!

Name	Link
🔨 Latest commit	`028bd6f`
🔍 Latest deploy log	https://app.netlify.com/sites/frosty-curran-1fc0c4/deploys/65fad84080133e00089dba62
😎 Deploy Preview	https://deploy-preview-305--frosty-curran-1fc0c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

rebekah-lawrence

Before I can do a proper review, I need to understand why the change in name from toolbar and menu to Top Bar and Side Bar.

I do not see this change as providing any further information to users - potentially Title Bar and Side Navigation are clearer, or even Top Menu and Side Menu/Navigation. In fact, we don't really have to name the toolbar (and I agree, it isn't a toolbar), we can just say Select x, located at the top of the screen, or Select x from the options at the top of the screen.

In general, however, these must be referred to as "the x Bar", not just "x Bar"

This will be a job for the IA/style guide/doc improvements. Noting for @docs team; nothing for you to do. Click ought to be changed to Select throughout. However, I see that Click is used across the MC docs, so it is not worth changing in just these updates. In the same area, per is Latin, ought to be for each.

emrberk · 2024-03-13T10:18:00Z

Before I can do a proper review, I need to understand why the change in name from toolbar and menu to Top Bar and Side Bar.

I do not see this change as providing any further information to users - potentially Title Bar and Side Navigation are clearer, or even Top Menu and Side Menu/Navigation. In fact, we don't really have to name the toolbar (and I agree, it isn't a toolbar), we can just say Select x, located at the top of the screen, or Select x from the options at the top of the screen.

In general, however, these must be referred to as "the x Bar", not just "x Bar"

This will be a job for the IA/style guide/doc improvements. Noting for @docs team; nothing for you to do. Click ought to be changed to Select throughout. However, I see that Click is used across the MC docs, so it is not worth changing in just these updates. In the same area, per is Latin, ought to be for each.

Hi Rebekah,

Top Bar (previously referred as Toolbar) does not contain any tools but selecting cluster right now. That's why I changed the naming here. Side Bar contains SQL browser and Console buttons as well as Menu. So, We can't call it "menu" now, because Menu is just a part of Side Bar and can be opened/closed. Side Bar and Top Bar may not be the best naming, and one can come up with better names for them. I just referred them as in our repository, so feel free to revise it.
Luckily, we don't have so many text updates in this PR, but mostly screenshots :)

rebekah-lawrence · 2024-03-13T11:06:41Z

I've requested @pawelklasa's review - he will doubtless have better ideas than I on how we should refer to the UI elements.

jgardiner68 · 2024-03-13T11:23:29Z

@emrberk Screen shots look good. The bulk are updated images but there are more deletions than additions. Have we confirmed that this is not removing useful images from the docs?

jgardiner68 · 2024-03-13T11:32:13Z

docs/modules/data-structures/pages/map.adoc

Backups, Locks and Dirty Entries are still available but have been added to another view to simplify the layout.

Added them again, please take a look.

jgardiner68 · 2024-03-13T11:33:59Z

docs/modules/clusters/pages/clients.adoc

@@ -20,9 +20,6 @@ image:ROOT:ClientGridView.png[Client Grid View]
 |Type
 |Type of client. This field usually contains the client's programming language.

-|Enterprise


Why has this been removed? IIRC we still have EE and non-EE Java clients (The change was to merge the Enterprise column into another column)

They are merged to "Type" column, shown as "Java Enterprise". So this column does not exist anymore.

Sure but the concept of a Java Enterprise and non Enterprise client still exists so the update to the Type column should be explained.

What happened to client labels?

Added the description about Enterprise to Type column, can you please take a look at it?

What happened to client labels?

It exists in Client Labels View. Explanation is still present.

jgardiner68 · 2024-03-13T11:34:28Z

docs/modules/clusters/pages/clients.adoc

@@ -36,9 +33,6 @@ members all the time.
 |UUID
 |Universally unique identifier of the client.

-|Labels


This has been added to a view in the table -- the functionality still exists!

Added it again.

jgardiner68 · 2024-03-13T11:35:12Z

docs/modules/clusters/pages/cluster-license.adoc


 - *License Key Hash*: SHA-256 hash of the key as a Base64 encoded string. The actual key is not displayed for security reasons.
 - *Expires*: The date on which the license will expire.
 - *Licensed Cluster Members*: The total number of members that the license supports and the current number of members running on the license.
- *License Type*: The type of license.


has this info been moved elsewhere?

It doesn't exist anymore, at least not in this page.

The "30 days warning" is important

docs/modules/cp-subsystem/pages/atomic-ref.adoc

jgardiner68 · 2024-03-13T11:36:55Z

docs/modules/data-structures/pages/executor.adoc

@@ -17,27 +17,8 @@ image:ROOT:MonitoringExecutors.png[Monitoring Executors]
 On top of the page, there are two graphs that show various metrics of the Executor.
 See the xref:getting-started:graphs.adoc[graph section] for more information.

-image:ROOT:MonitoringOptionsExecutor.png[alt=Monitoring Options for Executor]
-
-When you click on a desired monitoring, the chart loads with the


What has changed here to remove this section?

I guess this feature is from 4.x, take a look at the screenshot. We don't have options there anymore.

jgardiner68 · 2024-03-13T11:37:20Z

docs/modules/data-structures/pages/map.adoc

 |Entry Memory
 |Memory cost of owned entries in the member.

-|Backups


Moved to a different view

jgardiner68 · 2024-03-13T11:37:31Z

docs/modules/data-structures/pages/map.adoc

@@ -174,15 +171,6 @@ the member, including those which are no longer in the map (for
 example, may have been evicted). The number of hits may be inaccurate
 after a partition is migrated to a new owner member.

-|Locks


moved to a different view

jgardiner68 · 2024-03-13T11:37:45Z

docs/modules/data-structures/pages/map.adoc

 |Max Avg Put Latency
 |Maximum average latency of put operations on the member.

 |Max Avg Get Latency
 |Maximum average latency of get operations on the member.

-|Max Avg Remove Latency


moved to a different view?

Not even in a different view, added it again.

docs/modules/deploy-manage/pages/updating-mc-license-ui.adoc

jgardiner68

Concerned that some sections have been removed from the docs whereas those columns have been moved to different views in the same table. This should be explained.

Is there a doc page to explain the Licensed Features page?

emrberk · 2024-03-13T13:12:05Z

@emrberk Screen shots look good. The bulk are updated images but there are more deletions than additions. Have we confirmed that this is not removing useful images from the docs?

Yes, I checked the usage of the screenshots. There were many legacy ones so I removed them.

emrberk · 2024-03-13T13:14:28Z

Concerned that some sections have been removed from the docs whereas those columns have been moved to different views in the same table. This should be explained.

Is there a doc page to explain the Licensed Features page?

Addressed the review comments about the removed columns. We don't have a doc page for promo.

rebekah-lawrence

Language is consistent with other MC content. Approving.

jgardiner68 · 2024-03-13T14:26:31Z

docs/modules/data-structures/pages/map.adoc

@@ -153,9 +153,12 @@ From left to right, this table lists the following:
 |Puts
 |Number of put operations received by the member.

-|Removes
+|Removals


Please keep it consistent and use "removes"

Wht about Backups, Backup Memory, Locks, Dirty Caches

The table column is named as "Removals". In other data structure pages, we also refer to it as "Removals", despite having "Removes/s" in throughput statistics. That's why I put "Removals" here.

Wht about Backups, Backup Memory, Locks, Dirty Caches

Can you elaborate?

jgardiner68 · 2024-03-13T14:28:55Z

docs/modules/clusters/pages/clients.adoc

@@ -20,9 +20,6 @@ image:ROOT:ClientGridView.png[Client Grid View]
 |Type
 |Type of client. This field usually contains the client's programming language.

-|Enterprise


Sure but the concept of a Java Enterprise and non Enterprise client still exists so the update to the Type column should be explained.

jgardiner68 · 2024-03-13T14:29:43Z

docs/modules/clusters/pages/clients.adoc

@@ -20,9 +20,6 @@ image:ROOT:ClientGridView.png[Client Grid View]
 |Type
 |Type of client. This field usually contains the client's programming language.

-|Enterprise


What happened to client labels?

jgardiner68 · 2024-03-13T14:30:45Z

docs/modules/clusters/pages/cluster-license.adoc


 - *License Key Hash*: SHA-256 hash of the key as a Base64 encoded string. The actual key is not displayed for security reasons.
 - *Expires*: The date on which the license will expire.
 - *Licensed Cluster Members*: The total number of members that the license supports and the current number of members running on the license.
- *License Type*: The type of license.


The "30 days warning" is important

* Align docs with MC 5.4.0 * fix usage of Side Bar and Top Bar * add enterprise information to type column explanation * update data structure page information

emrberk requested review from promanenko and rebekah-lawrence March 12, 2024 17:53

promanenko requested a review from jgardiner68 March 13, 2024 07:58

rebekah-lawrence reviewed Mar 13, 2024

View reviewed changes

rebekah-lawrence requested a review from pawelklasa March 13, 2024 11:05

jgardiner68 reviewed Mar 13, 2024

View reviewed changes

docs/modules/cp-subsystem/pages/atomic-ref.adoc Show resolved Hide resolved

jgardiner68 reviewed Mar 13, 2024

View reviewed changes

docs/modules/deploy-manage/pages/updating-mc-license-ui.adoc Show resolved Hide resolved

jgardiner68 requested changes Mar 13, 2024

View reviewed changes

Align docs with MC 5.4.0

c1d8bc8

emrberk force-pushed the 5.4.0-updates branch from a92ade6 to c1d8bc8 Compare March 13, 2024 13:08

emrberk requested a review from jgardiner68 March 15, 2024 09:17

fix usage of Side Bar and Top Bar

4e65328

rebekah-lawrence approved these changes Mar 15, 2024

View reviewed changes

jgardiner68 approved these changes Mar 15, 2024

View reviewed changes

add enterprise information to type column explanation

8b84079

pawelklasa approved these changes Mar 18, 2024

View reviewed changes

update data structure page information

028bd6f

emrberk merged commit dd2ceb5 into main Mar 20, 2024
6 checks passed

emrberk deleted the 5.4.0-updates branch March 20, 2024 12:40

promanenko pushed a commit that referenced this pull request Apr 10, 2024

Align docs with MC 5.4.0 (#305)

b1f9a73

* Align docs with MC 5.4.0 * fix usage of Side Bar and Top Bar * add enterprise information to type column explanation * update data structure page information

Align docs with MC 5.4.0 #305

Align docs with MC 5.4.0 #305

Conversation

emrberk commented Mar 12, 2024

netlify bot commented Mar 12, 2024 • edited Loading

✅ Deploy Preview for frosty-curran-1fc0c4 ready!

rebekah-lawrence left a comment

Choose a reason for hiding this comment

emrberk commented Mar 13, 2024

rebekah-lawrence commented Mar 13, 2024

jgardiner68 commented Mar 13, 2024

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

jgardiner68 left a comment

Choose a reason for hiding this comment

emrberk commented Mar 13, 2024

emrberk commented Mar 13, 2024

rebekah-lawrence left a 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

netlify bot commented Mar 12, 2024 •

edited

Loading