[
https://issues.apache.org/jira/browse/TINKERPOP-2995?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17779428#comment-17779428
]
ASF GitHub Bot commented on TINKERPOP-2995:
-------------------------------------------
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.
> Create Sample Applications in each GLV
> --------------------------------------
>
> Key: TINKERPOP-2995
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2995
> Project: TinkerPop
> Issue Type: Improvement
> Components: dotnet, go, javascript, python
> Affects Versions: 3.5.7
> Reporter: Yang Xia
> Priority: Major
>
> It would be great to have working example applications for each GLV, with
> basic traversal examples and common connection settings.
> Currently we have an `example.py` for python, but it is very minimal. There
> is also an `example.go` for golang, but that appears to be outdated. As far
> as I know, dotnet only has templates and javascript doesn't have any examples
> at all.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
