salesforce: docs deep dive

[josephjclark]

This issue is to do a deep docs review on Salesforce. I expect to contribute heavily to this myself. good examples

Requirements:

• state mutation JSdocs
• careful consistent language
• http helpers must explicitly clearly target salesforce
• update, create and upsert example supports multiple records
• bulk upsert example
• Example for each supported bulk operation
• Ensure examples are clear, concise, and demonstrate best practices.

[mtuchi]

I won't be able to work on this issue this week, We should probably promote to next week sprint

[mtuchi]

@aleksa-krolls this issue

[mtuchi]

@josephjclark i need second opinion, is this a good first issue for salesforce adaptor ?. I am curios if we should start with https://github.com/OpenFn/adaptors/issues/663 ?

[josephjclark]

@mtuchi We need a good round of documentation and unit tests before we port the jsforce version. The idea is to have a stable base to migrate from. It may help catch issues in the library.

So an ideal start is to go through and make sure docs are a) complete and b) accurate. That doesn't mean hundreds of words - it means links to salesforce or jsforce documentation, it means state tables and maybe object definitions, it means concise and helpful examples.

[mtuchi]

EOD Update #799 Unit test are failing because of @state tag. Joe is helping me investigating

[aleksa-krolls]

Hey @mtuchi what is status here? Pls leave EOD updates... especially on Friday!

Also, if there is work left here - pls make sure to prioritize client work before picking this back up.

[mtuchi]

I have a draft PR already i just need to clean up and ask Joe for review, I will pick this up tomorrow

[mtuchi]

EOD Update

This is done and ready for review, See #821