Add examples from MongoDB Docs

[biniona-mongodb]

Add versioned examples from the Kafka IA-v2 docs set.

JIRA: https://jira.mongodb.org/browse/DOCSP-19236

[biniona-mongodb]

PR Hints:

• The docs-examples/source directory defines sample-pipelines for examples
• The docs-example/scripts directory generates versioned examples from the source directory
• The docs-examples/unsupported directory gives a template for a message to display for versions of the connector that are not supported in tutorials/quickstarts

The areas I think deserve the most attention in this review are as follows:

• docs-example/scripts/build.py
• Using string replacement to differentiate connector versions
• docs-examples/unsupported

[ccho-mongodb]

First, this is this ticket, correct? https://jira.mongodb.org/browse/DOCSP-19236
I didn't see it linked in the description and am trying to get some context. Here are some questions that might steer any further feedback:

1. Is this a repository that we're going to have documentation readers clone?
2. Are we expecting them to run the build.py script or is that only for docs writers?
3. I only looked at build.py, docs-examples/unsupported/README.md, and docs-examples/README.md as I wasn't able to decipher what "Fix issue where identical image names made it difficult to quickly switch between different examples" meant on Slack. Is there anything else I should take a look at?

[biniona-mongodb]

Hi @ccho-mongodb, thanks for the feedback. I ran the code through pylint (should've done that before passing it off 🤦) and addressed feedback. The answers to the preceding questions are as follows:

0. Yes, https://jira.mongodb.org/browse/DOCSP-19236 is the correct ticket. I've added it to the description.
1. Yes, this is the repository docs readers will clone
2. Yes, build.py is only for docs writers.
3. No, I don't think there is anything else to take a look at.

Apologies for being unclear. What I meant by "Fix issue where identical image names made it difficult to quickly switch between different examples" relates to the following scenario:

• Reader completes quickstart
• Reader attempts to complete CDC example
• Reader's Docker instance uses cached version of shell image as opposed to rebuilding activity specific shell, and reader experiences issue in example (such as jq not being included in environment).

By giving the images unique to an activity names specific to that activity, Docker rebuilds images that differ between examples when switching between examples without needing to prune images.

[ccho-mongodb]

LGTM with a few comments and nitpicks.

I think you should not spend much time with fiddling with the build.py script. Eventually, we should probably replace it with a shell script or other mechanism to remove the unnecessary dependency on python.

[biniona-mongodb]

Whoops looks like there is a setting on this repo that automatically dismisses reviews if a significant amount of the content changes after the review takes place. Apologies, you may have to leave another approving review @ccho-mongodb. I'll ask @RWaltersMA to disable this feature as it does not seem to be present on our other repos.

[ccho-mongodb]

LGTM, left a couple comments. To reiterate my comment from before, we should spend a minimal amount of time/effort on the python script and the pseudo-template mechanism.

[ccho-mongodb]

This looks good, but the rest of the function comments don't follow the recommended form yet.

[biniona-mongodb]

updated remaining function doc-strings

[ccho-mongodb]

To reiterate my prior feedback, this isn't necessary because the info is not used. The dict you had originally just mapping named version to confluent version or None was fine and easier to understand (e.g. "v1.6": "1.6.1").