Florian Hockmann commented on TINKERPOP-1885:

I went ahead and cleaned up the *{{csproj}} file*. It now just contains a 
{{description}} element:


I also rewrote the NOTE about the state of Gremlin.Net a bit as it stated 
before that the non-TinkerPop Gremlin.Net version would be still supported 
which isn't really the case any more. We should remove this note completely 
when most users switched over to the newer Gremlin.Net versions (maybe after 
the next official release).

Regarding the *READMEs*: I agree that they aren't that useful and basically 
just repeat information from the reference docs. But on the other hand, we 
don't really have anything like a landing page for the different GLVs which 
seems to result in search engines like Google listing the GLV modules in the 
GitHub repo above the reference docs. When I search for example for "gremlin 
python" then the second result is: 
[https://github.com/apache/tinkerpop/tree/master/gremlin-python] (the first one 
is the pypi package) and the reference docs come much later. For "Gremlin .NET" 
it's basically the same and for "Gremlin C#" I don't even see any TinkerPop 
link on the first page. So adding a README might be an intermediate solution to 
provide something like a landing page for the GLVs. In the long term, the 
better option might be to split the reference docs into several pages.

Another related thing that just came to my mind: Should we add *icons* for the 
GLVs that don't have one yet? For Gremlin.Net, we could add a Gremlin icon to 
the package and maybe the TinkerPop logo for the TinkerPop account.

> 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

Reply via email to