Restructuring Contributing doc [skip ci]

[iskode]

This PR is related to the raised issue here. It is a refactoring of the contributing doc with instructions to locally build cuDF in edit mode.

[GPUtester]

Can one of the admins verify this patch?

[iskode]

This PR takes into account the change proposed here

[shwina]

Thanks for your work on this @iskode! I love the new structure - it greatly improves the flow of the document! Left a few suggestions that I think could help with clarity.

[iskode]

should we not add instructions for java developers?
Also should we not provide steps for kafka, custreamz edit mode installations ?

[shwina]

should we not add instructions for java developers?

That's a good question. @jlowe any thoughts here?

Also should we not provide steps for kafka, custreamz edit mode installations ?

That would be great! Personally, I don't have any experience with developing those libraries, so I'd ask @jdye64 to review once you've written up those instructions!

[jlowe]

Feel free to lift instructions from the Java README or link to that document from here. If instructions are copied then we should probably have the Java README point back to the contributing doc to avoid duplicating instructions and allowing them to accidentally diverge over time.

[iskode]

I think linking Java README from here will be fine.
But, please @jlowe can you confirm that there are instructions for installing the java binding in edit mode as I don't know well maven ? Because these are main missing points for python cudf and dask_cudf that this PR attempts to cover. the current version only states how to build/install from source in a non editable way.
This makes me thinking about C++ libcudf, @shwina do instructions from this PR make it editable ?

[jlowe]

installing the java binding in edit mode

Can you clarify what you mean by this? I think I understand what you mean for Python, e.g.: hacking directly on deployed source files from the install, but that doesn't have an equivalent in Java.

[iskode]

Ok @jlowe , thank you for recalling me. Yes java is a compiled language so edit mode makes only sense for python.

[iskode]

I have incorporated suggested changes and refactor subsection titles to make them clear and short.
I believe we are good to go now except some omissions.

[shwina]

Thanks @iskode -- there's one last change I would ask for: we are inconsistent here about including the prompt ($) in the commands. Can we go ahead and omit the prompt in all the commands? It makes it easier for people to copy and paste commands into their terminal as well.

My apologies for the back and forth on this PR - really appreciate your patience and excellent improvements to this doc :)

[iskode]

Thanks @iskode -- there's one last change I would ask for: we are inconsistent here about including the prompt ($) in the commands. Can we go ahead and omit the prompt in all the commands? It makes it easier for people to copy and paste commands into their terminal as well.

You're right because even me I always copy and paste.

My apologies for the back and forth on this PR - really appreciate your patience and excellent improvements to this doc :)

No problem, I really enjoy the process of thinking/suggesting ideas back and forth.

[iskode]

Thank you @shwina for the suggestions. I've removed all prompt ( $ ) in the doc.

[shwina]

This LGTM. @robertmaynard could you please review/approve when you have a chance. Thanks!

[raydouglass]

ok to test

[shwina]

@gpucibot merge