search

ibm-cloud-docs / hs-crypto

hs-crypto
3 stars 22 forks source link

HSM initialisation by key part files : Needs document updates #38

Closed vishwabmc closed 1 year ago

vishwabmc commented 2 years ago

I am going through TKE by key part files and see it points to pre-requisites page. There, it shows this.

Screenshot 2022-10-13 at 2 04 57 PM

This expects the user to get to another link to login to IBM cloud, and the text below shows to point to the right target. So, in my view, it's not clear. It would be clean if we only gave the command here showing logging into IBM cloud too. Can the document be updated to contain this

Best would be, if we could keep all this in here itself

At the least, this-link needs a Pre-requisite section. The way it is now. it's right after the video and is very easy for someone to just miss it.

Screenshot 2022-10-13 at 2 08 40 PM

Having its own section for pre-requisites would help make it clear.

TiffanyLiIBM commented 2 years ago

Hi @vishwabmcm, Many thanks for providing comments to the docs.

I've updated the Before you begin topic to include the command to login to IBM Cloud:

image

And also, a section header is included in the Initializing service instances using key part files topic so that the prerequisite is standout.

image

Since the Before you begin topic info is used across all service initialization approaches, we didn't include it in a single topic for easy maintenance. Hope it makes sense.

Please review and let us know if you have additional comments. Thanks!

TiffanyLiIBM commented 1 year ago

No more comments received. Closing...