FlorianHockmann commented on PR #2298: URL: https://github.com/apache/tinkerpop/pull/2298#issuecomment-1778870093
> 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](https://tinkerpop.apache.org/docs/current/reference/#gremlin-dotnet-examples) [src](https://github.com/apache/tinkerpop/tree/master/gremlin-dotnet/src/Gremlin.Net.Template)) as it basically served the same purpose and we don't need two example applications for .NET. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@tinkerpop.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
