TINKERPOP-2995 Create Sample Applications in each GLV

[ryn5]

https://issues.apache.org/jira/browse/TINKERPOP-2995
Created sample applications for each GLV in Java, Python, C#, JS, and Go which includes connection, basic Gremlin, and simple traversal examples.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (05ac05d) 76.17% compared to head (0a47f61) 76.17%.
Report is 33 commits behind head on 3.7-dev.

Additional details and impacted files

@@            Coverage Diff             @@
##             3.7-dev    #2298   +/-   ##
==========================================
  Coverage      76.17%   76.17%           
- Complexity     13113    13114    +1     
==========================================
  Files           1083     1083           
  Lines          64995    64995           
  Branches        7259     7259           
==========================================
+ Hits           49510    49513    +3     
+ Misses         12789    12784    -5     
- Partials        2696     2698    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[FlorianHockmann]

I only reviewed the .NET example. Apart from my minor inline comments, I have two general questions:

• Are the examples already included in our build pipeline? Because it looks to me like they aren't built via GH Actions.
• How do we want to use the examples / How do we make users aware of them?

[ryn5]

@FlorianHockmann The examples aren't integrated into the pipeline or GH actions, but they are self-contained as simple projects in their respective example folders and can be run after building. Currently undecided on where to introduce them to users, but we could maybe add them to either the docs in each GLV section or in README files.

[FlorianHockmann]

The examples aren't integrated into the pipeline or GH actions, but they are self-contained as simple projects in their respective example folders and can be run after building.

I think we should look into adding them to the main Maven build and at least add a smoke test for them (like executing the methods to ensure that no exception gets thrown) so they are covered by GH actions. Otherwise, we won't notice if we break them, e.g., by changing some API.
This probably means however that their connection parameters need to be changed as the test server doesn't listen on port 8182.

Currently undecided on where to introduce them to users, but we could maybe add them to either the docs in each GLV section or in README files.

I think a short mention in the reference docs for each GLV would be great as that is the place where we mostly document the GLVs. README files could of course also make sense, especially if the applications contain more than a single file (depending on @kenhuuu's comment) to briefly explain the application and its structure. README's are usually also what search engines will link to so that's where users will land if they didn't follow a link from somewhere else in our docs.

We should probably also remove the current Gremlin.Net.Template (docs src) as it basically served the same purpose and we don't need two example applications for .NET.

[spmallette]

This probably means however that their connection parameters need to be changed as the test server doesn't listen on port 8182.

if we use a nonstandard port i think it would be good to ensure the comments are clear that the standard port is 8182.

[FlorianHockmann]

Maybe I'm also overcautious here and we don't need any tests. Ensuring that the applications still compile probably already covers most cases as we would already notice breaking changes. But then I would at least let GH actions build the applications which should be easy to do by integrating them into the Maven build.

[kenhuuu]

Maybe I'm also overcautious here and we don't need any tests. Ensuring that the applications still compile probably already covers most cases as we would already notice breaking changes. But then I would at least let GH actions build the applications which should be easy to do by integrating them into the Maven build.

This has already turned out to be a really good idea as #2366 would already cause these examples to break eventually.

[Cole-Greer]

Thanks Ryan! Overall the changes here look good to me, just added a few minor comments.

[Cole-Greer]

Thanks for all the updates Ryan!

VOTE +1

[vkagamlyk]

VOTE+1