[jira] [Commented] (CASSANDRA-18035) Add "Hello World" docker-based quick start development guide

["Paulo Motta (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CASSANDRA-18035?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17631942#comment-17631942 ] 

Paulo Motta commented on CASSANDRA-18035:
-----------------------------------------

A preliminary patch is available on [https://github.com/apache/cassandra/pull/1996]

> Add "Hello World" docker-based quick start development guide
> ------------------------------------------------------------
>
>                 Key: CASSANDRA-18035
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-18035
>             Project: Cassandra
>          Issue Type: Task
>            Reporter: Paulo Motta
>            Priority: Normal
>
> I propose adding a new {{QUICKSTART.md}} guide that provides instructions to beginner contributors on how to:
> a) Setup a development environment and IDE from scratch on WSL/Ubuntu/Debian environments
> b) Run a simple unit test from the IDE
> c) Create a simple patch that prints "Hello World" during Cassandra initialization
> d) Test the patch on a local docker instance
> A new {{docker/}} directory is added along with the guide with the following utilities:
> a) Dockerfile: unoptimized vanilla docker image manifest suitable only for local dev testing.
> b) build.sh: build a cassandra artifact and cassandra-test image.
> c) start.sh: start local cassandra-test container.
> d) stop.sh: stop local-cassandra test container.
> A couple of follow-up improvements that come to mind:
>  - Add ant targets to build/start cassandra-test container.
>  - Add OSX instructions.
>  - More IDE setup instructions (ie. Intellij/VScode).
>  - A more involved Hello World example, perhaps with unit/dtests.
>  - Update Dockerfile to point to build/ instead of creating an artifact.
> A DEV mailing list message will follow to gather community feedback on this proposal.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org