search

hazelcast / management-center-docs

Source content for the Hazelcast Management Center documentation
https://docs.hazelcast.com/management-center/latest
3 stars 19 forks source link

Align docs with MC 5.4.0 #305

Closed emrberk closed 7 months ago

emrberk commented 7 months ago
netlify[bot] commented 7 months ago

Deploy Preview for frosty-curran-1fc0c4 ready!

Name Link
Latest commit 028bd6f6acf576c3194bbde6a277943660d5bd28
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...

QR Code

Use your smartphone camera to open QR code link.

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

emrberk commented 7 months ago

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 commented 7 months ago

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

jgardiner68 commented 7 months ago

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

emrberk commented 7 months ago

@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 commented 7 months ago

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.