You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tinkerpop.apache.org by Divij Vaidya <di...@gmail.com> on 2020/10/08 22:49:54 UTC
[DISCUSS] Adding examples for client usage
Hello all
This is regarding https://issues.apache.org/jira/browse/TINKERPOP-2244
<https://issues.apache.org/jira/browse/TINKERPOP-2244>
I wanted to discuss the right place to put the example code at. My
suggestion is as follows and please let me know if you have any suggestions.
1. Create a new examples plugin in the main TinkerPop maven project similar
to netty project <https://github.com/netty/netty/tree/4.1/example>.
2. Examples for all languages will be added there.
3. The examples will be cross linked from the main website similar to this
Google SDK <https://cloud.google.com/docs/authentication#examples> i.e.
tabs for multiple languages with a link to github code on each.
4. These examples will be available in https://tinkerpop.apache.org/ >
Tutorials > TinkerPop driver user guide.
Divij Vaidya
Re: [DISCUSS] Adding examples for client usage
Posted by David Bechberger <da...@bechberger.com>.
I am favoring Divij's proposal and replacing the current examples (which I
didn't even know about until now) with a repo of examples similar to
netty.
On Fri, Oct 9, 2020 at 3:49 AM Stephen Mallette <sp...@gmail.com>
wrote:
> I like the idea for /examples especially when using netty as the context. I
> think it's smart to put these in a specific "TinkerPop Driver Guide" too.
>
> I wonder if /examples removes the need for the project templates we
> maintain now. In other words, if we have fully working examples in all
> languages do we need to have gremlin-archetype, Gremlin.Net.Template and
> the random example.py? I think our motivation in adding those was more to
> provide example usage in platform specific ways, but to use project
> template infrastructure for that seems over done. It's not like we generate
> all this project infrastructure like Spring or Hibernate. We basically just
> generate little main() functions and some example code. I think we might be
> able to drop all that. Thoughts?
>
>
>
> On Thu, Oct 8, 2020 at 6:50 PM Divij Vaidya <di...@gmail.com>
> wrote:
>
> > Hello all
> >
> > This is regarding https://issues.apache.org/jira/browse/TINKERPOP-2244
> > <https://issues.apache.org/jira/browse/TINKERPOP-2244>
> >
> > I wanted to discuss the right place to put the example code at. My
> > suggestion is as follows and please let me know if you have any
> > suggestions.
> >
> > 1. Create a new examples plugin in the main TinkerPop maven project
> similar
> > to netty project <https://github.com/netty/netty/tree/4.1/example>.
> > 2. Examples for all languages will be added there.
> > 3. The examples will be cross linked from the main website similar to
> this
> > Google SDK <https://cloud.google.com/docs/authentication#examples> i.e.
> > tabs for multiple languages with a link to github code on each.
> > 4. These examples will be available in https://tinkerpop.apache.org/ >
> > Tutorials > TinkerPop driver user guide.
> >
> > Divij Vaidya
> >
>
Re: [DISCUSS] Adding examples for client usage
Posted by Stephen Mallette <sp...@gmail.com>.
I like the idea for /examples especially when using netty as the context. I
think it's smart to put these in a specific "TinkerPop Driver Guide" too.
I wonder if /examples removes the need for the project templates we
maintain now. In other words, if we have fully working examples in all
languages do we need to have gremlin-archetype, Gremlin.Net.Template and
the random example.py? I think our motivation in adding those was more to
provide example usage in platform specific ways, but to use project
template infrastructure for that seems over done. It's not like we generate
all this project infrastructure like Spring or Hibernate. We basically just
generate little main() functions and some example code. I think we might be
able to drop all that. Thoughts?
On Thu, Oct 8, 2020 at 6:50 PM Divij Vaidya <di...@gmail.com> wrote:
> Hello all
>
> This is regarding https://issues.apache.org/jira/browse/TINKERPOP-2244
> <https://issues.apache.org/jira/browse/TINKERPOP-2244>
>
> I wanted to discuss the right place to put the example code at. My
> suggestion is as follows and please let me know if you have any
> suggestions.
>
> 1. Create a new examples plugin in the main TinkerPop maven project similar
> to netty project <https://github.com/netty/netty/tree/4.1/example>.
> 2. Examples for all languages will be added there.
> 3. The examples will be cross linked from the main website similar to this
> Google SDK <https://cloud.google.com/docs/authentication#examples> i.e.
> tabs for multiple languages with a link to github code on each.
> 4. These examples will be available in https://tinkerpop.apache.org/ >
> Tutorials > TinkerPop driver user guide.
>
> Divij Vaidya
>