Expanded User Docs - WIP (Feedback Requested)

[aaronsteers]

Description of change

As a new user and someone completely unfamiliar with Clojure, I struggled to get started on this tap. @dmosorast has been very helpful in slack and I thought I would try to contribute back to the docs at the same time as I am getting this setup for myself.

QA steps

• automated tests passing
• manual qa steps passing (list below)
• Search and resolve any references to TK (why TK?) or TODO: before merging.

Risks

• Minimal risk. Most/all changes are documentation-related, creating dedicated markdown docs in a new docs folder. I have tried to be very careful to not remove any content, while still cleaning up and simplifying the main README.md file.
• For my purposes, I seemed to be able to test using simply java as the path instead of a hardcoded java path. If this breaks anyone else, we may need to revert. Ideally, I think we would check first for JAVA_HOME and then fallback to java if it's on the path.

Rollback steps

• revert this branch

[cmerrick]

Hi @aaronsteers, thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes.

[aaronsteers]

Adding some TODO items based on the TK / TODO entries:

• 1 - /README.md: Recommend a docker image for docker-based execution instructions:
  • Create Dockerfile (ideally at root of repo) or reference one from another source repo.
  • Publish the docker image
  • Automate docker image maintenance
• 2 - /docs/config.md: Add instructions for log-based replication. (I don't know how this is configured yet.)
• 3 - /docs/config.md: Confirm whether there are any settings still missing.
• 4 - docs/CONTRIBUTING.md: Optionally, add guidelines/instructions for contributors to this default path, or delete file if not needed.
• 5 - /docs/installation.md: Confirm JRE works for runtime-only environments (not developing or compiling).
• 6 - docs/installation.md: Add any specific prerequisites or workstation config steps for developers/testers (if applicable).

[aaronsteers]

Update: Successfully tested installation and execution on Windows with JRE only (not JDK). Resolving checkbox 5 above.

[cmerrick]

You did it @aaronsteers!

Thank you for signing the Singer Contribution License Agreement.

[aaronsteers]

To any active code maintainers, I could use guidance on item #s above: 2 (how does log-based replication get configured?) and 3 (am I'm missing any config options in docs/config.md?).

Thanks!

[aaronsteers]

I also intend to take a stab at the Dockerfile and docker image - although I can host+manage that Dockerfile elsewhere if you'd rather not add more to maintain here.

UPDATE: Completed Dockerfile, ready for review