gemini icon indicating copy to clipboard operation
gemini copied to clipboard

Document easy way and hard way to run Gemini

Open bzz opened this issue 7 years ago • 2 comments

After #95, update the README structure, add

  • "Easy Way" a quickstart for Gemini \w containers
  • "Hard Way" as discussed in #84, a separate file under /docs/, with description on how to run it on Apache Spark cluster \w Scylla/Cassandra with all the details
  • Apply suggestions from https://github.com/src-d/guide/blob/master/engineering/documentation.md

This change can bee small - it does not need to be "complete" in documentation coverage or full conformance \w doc guide from above, but it has to setup the right "structure" of our user-facing documentation, that will be improved later.

bzz avatar Apr 17 '18 09:04 bzz

As discussed in https://github.com/src-d/gemini/pull/119#discussion_r187014649 - it would include moving information on running individual dependencies form ./scripts/ to the developer documentation and deleting the scripts

bzz avatar May 10 '18 08:05 bzz

Sorry I've misclosed it 😅.

se7entyse7en avatar Feb 15 '19 15:02 se7entyse7en