[jira] [Commented] (GORA-338) Complete site documentation for gora-dynamodb

["Su Win (Jira)" <ji...@apache.org>]

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

Su Win commented on GORA-338:
-----------------------------

Hi [~chrismattmann] and [~lewismc] ,

I am Su, an applicant for the Outreachy internship Dec 2020 program. I am currently studying computer science (in my first year) and have just completed Object Oriented Programming (Java) subject in which I learnt core java OOP and a bit about java collections.  My initial application is approved.

I am interested in the *Add datastore for Elasticsearch* project. As part of the warm-up task, I would like to work on this issue. 

I have checked the current page, [http://gora.apache.org/current/gora-dynamodb.html#overview], which contains minimal information. I had a look at Gora MongoDB and Cassandra doc pages so that I have a rough idea about the type of contents I need to add to the document.
 * [https://gora.apache.org/current/gora-mongodb.html]
 * [http://gora.apache.org/current/gora-cassandra.html]

[~lewismc], I see you as assignee. I would like to know whether it is OK if I work on it or collaborate with you?

I have the following questions regarding this *gora-dynamodb* task.
 * *_Correct repo checking :_* Based on the Gora MongoDB and Cassandra documents, I assume that I need to check into this repo. [https://github.com/apache/gora/tree/master/gora-dynamodb/src/main/java/org/apache/gora/dynamodb]
 ** Is my assumption correct?

 * *_Documentation Draft location:_* Where should I add my draft documentation for review and discussion? I have a github account. Normally, I add the project documentation into the project folder.
 ** Should I pull this repo, [https://github.com/apache/gora/tree/master/gora-dynamodb/src/main/java/org/apache/gora/dynamodb and add README.file|https://github.com/apache/gora/tree/master/gora-dynamodb/src/main/java/org/apache/gora/dynamodb%20and%20add%20README.file] , and call this document as README.md?
 ** Or Should I create a draft under this [http://gora.apache.org/current/gora-cassandra.html] site since all the documentation live here? If so, how should I do it? If so, could I be assigned to this task? 

Any other recommendation on where I should start or things to look out for?

Thank you.

> Complete site documentation for gora-dynamodb
> ---------------------------------------------
>
>                 Key: GORA-338
>                 URL: https://issues.apache.org/jira/browse/GORA-338
>             Project: Apache Gora
>          Issue Type: Improvement
>          Components: documentation, gora-dynamodb
>    Affects Versions: 0.4
>            Reporter: Lewis John McGibbney
>            Assignee: Lewis John McGibbney
>            Priority: Major
>             Fix For: 1.0
>
>
> We need to substantiate the site docs which currently reside at http://gora.apache.org/current/gora-dynamodb.html
> We should most likely also provide a page for dynamodb compiler



--
This message was sent by Atlassian Jira
(v8.3.4#803005)