Move "Hello, World!" code samples into separate repos

[rmloveland]

Richard Loveland (rmloveland) commented:

Currently, our "hello world" style code samples (such as for Java, Python, Go, etc.) are stored directly in the cockroachdb/docs git repo.

This is not ideal, since it means that developers who want to get the code have to do non-fun things like:

• Copy and paste code, which can introduce errors, or cause dependency issues
• Clone the whole docs repo and troll through its various folder structures to find the code they want

These actions can be tedious and/or error-prone, when you really just want to git clone.

To resolve this, we should store each of our "hello world" code samples in their own separate git repos.

Estimated scope of work for this issue is:

1. Come up with a consistent naming scheme for these repos so they are easily recognizable and discoverable. Also, they should sort nicely in the Github UI's "list of repos" view, while staying grouped by language. For example, a naming scheme that meets these requirements could be something like 'hello-world-java-jdbc', 'hello-world-java-hibernate', 'hello-world-python-psycopg2', 'hello-world-python-sqlalchemy', and so on. (This is the real work)
2. Create a git repo for each "hello world" code sample
3. Populate it with everything needed to build and run the code
4. Add a README documenting how to do the above

The work of integrating these code samples from external repos into the docs site proper, and testing that integration, etc., are not part of this issue. Those tasks are tracked in the linked issues below.

See also:

• Code samples should be stored in a repo #3203 which is saying basically the same thing as this issue, but its focus is on how to pull the external repo code samples into the docs, and testability from a docs website POV, which are related but somewhat orthogonal to this task, which is "get them each into separate repos"
• Automate the testing of code and the generation of output #3943, which also mentions separate repos but is also more about testing/automation from a docs team POV
• [Docs] SQL Developer Guide #5865 Developer Guide

Jira Issue: DOC-371