documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Add mapping parameters documentation

Open vagimeli opened this issue 1 year ago • 4 comments

Description

Add mapping parameters

Issues Resolved

#4300

Checklist

  • [X] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

vagimeli avatar May 08 '24 18:05 vagimeli

@mgodwan I was provided your name as the SME for mappings. Please confirm you're the appropriate point of contact. We need to close documentation content gaps for mappings parameters, including individual pages for each parameter. Thank you.

vagimeli avatar May 08 '24 18:05 vagimeli

@ankitkala @mgodwan - Can you please give us an ETA for the tech review? We’ve documented 4 parameters and want to make sure we’re on the right track. We need you to give a general approval. Based on your input, we'll document the remaining parameters.

hdhalter avatar Jun 10 '24 15:06 hdhalter

Checking now

mgodwan avatar Jun 10 '24 16:06 mgodwan

@hdhalter Apologies for the delay in reviewing this earlier.

Overall, the direction we're following looks good to me. I've left some high level comments on the documented fields. The description, example, and explanation pattern works well.

Are we planning another documentation update where for each field type (e.g. text, integer), we will document the paramters supported for that data type? I would like to see that as well to ensure users are aware how they can customize their mappings for any supported field using these parameters.

mgodwan avatar Jun 10 '24 16:06 mgodwan

A few small suggestions, otherwise LGTM.

Thanks for the review @Naarcha-AWS

vagimeli avatar Oct 10 '24 22:10 vagimeli