[jira] [Commented] (TINKERPOP-1885) Various Gremlin.Net documentation updates

["stephen mallette (JIRA)" <ji...@apache.org>]

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

stephen mallette commented on TINKERPOP-1885:
---------------------------------------------

I quickly handled the `/site` update:

[https://github.com/apache/tinkerpop/commit/0c083050f62736afc12bfb2274a7fe92b2691c79]

since that was kinda bad (change was just published). also removed that "warning" from reference docs:

[https://github.com/apache/tinkerpop/commit/5e1c878baca77a89f5ad1d59b148a80a4ba5ef00]

[~Florian Hockmann] i'll let you handle the README and csproj. I don't know if the README is necessary actually - i think we only had it for python because it's used to generate the description in pypi. my guess is that the javascript glv only has it because we copied to python. we could kill the one in javascript and not add one for .NET if it serves no real purpose. [~jorgebg] can you comment on usefulness of the README for javascript?

> Various Gremlin.Net documentation updates
> -----------------------------------------
>
>                 Key: TINKERPOP-1885
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-1885
>             Project: TinkerPop
>          Issue Type: Improvement
>          Components: documentation, dotnet
>    Affects Versions: 3.2.7, 3.3.1
>            Reporter: Florian Hockmann
>            Priority: Trivial
>
> We have some parts of the documentation regarding Gremlin.Net that should be updated now that we have a stable release:
>  * Homepage: _Query Languages_ misses a reference to Gremlin.Net
>  * Homepage: _Language Drivers_ section still links to the repository on my private account. It should probably link to the Gremlin.Net section in the reference docs or to a {{README}} (see below).
>  * Reference docs still contain a warning that _Gremlin.Net does not yet have an official release._
>  * Add a {{README}} that explains Gremlin.Net, similar to the documents we have for the Python and Javascript GLVs.
>  * The {{csproj}} file contains a pretty extensive {{summary}} element, but {{summary}} isn't part of the {{csproj}} standard. So it isn't used for anything. It should be merged into the {{description}} element instead.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)