Uploaded image for project: 'TinkerPop'
  1. TinkerPop
  2. TINKERPOP-209

Plugin names should be the full name, not shortered.

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Done
    • None
    • 3.0.0-incubating
    • plugin
    • None

    Description

      neo4j should be neo4j-gremlin
      giraph should be giraph-gremlin
      ...
      this way other people can provide their own (e.g.) Giraph implementations of TP3.

      Attachments

        Activity

          well - my thinking was that we would handle this by convention. both the asciidoc and javadoc explain that names need to be unique and should include a "namespace". by default, as tinkerpop, we have no namespace, hence it is safe for us to be just "neo4j" or "giraph". however, someone building their own neo4j plugin would do "better.neo4j" as their plugin name. i think i even have a issue out there somewhere to enforce namespacing in plugin naming.

          what do you think? still want the "full name" idea?

          spmallette Stephen Mallette added a comment - well - my thinking was that we would handle this by convention. both the asciidoc and javadoc explain that names need to be unique and should include a "namespace". by default, as tinkerpop, we have no namespace, hence it is safe for us to be just "neo4j" or "giraph". however, someone building their own neo4j plugin would do "better.neo4j" as their plugin name. i think i even have a issue out there somewhere to enforce namespacing in plugin naming. what do you think? still want the "full name" idea?

          Huh. That is a good rationale. I could flow with that..... however, won't mbroecheler call his plugin "titan" .. ? when, according to your logic, it should be "aurelius-titan" ... ..??. thus, we should set the "tone" with our plugins so people know. And then with that:

          tinkerpop.giraph
          tinkerpop.neo4j
          tinkerpop.tinkergraph
          aurelius.titan
          neo4j.neo4j
          facebook.giraph

          ?? ... or am I over thinking this.

          okram Marko A. Rodriguez added a comment - Huh. That is a good rationale. I could flow with that..... however, won't mbroecheler call his plugin "titan" .. ? when, according to your logic, it should be "aurelius-titan" ... ..??. thus, we should set the "tone" with our plugins so people know. And then with that: tinkerpop.giraph tinkerpop.neo4j tinkerpop.tinkergraph aurelius.titan neo4j.neo4j facebook.giraph ?? ... or am I over thinking this.

          ha - might be over-thinking but it's not a bad line of over-thinking.

          i thought about namespacing the TinkerPop plugins, but didn't do that for some plugin-type things in gremlin server - again, saving the namespace-less names for TinkerPop. so i followed suit with plugins.

          that said, i'm cool with namespacing everything in the manner you describe. i agree that if we set the pattern that way from the outset it might be easier to follow for others than just using "documentation". then we don't have that little loophole to worry about.

          spmallette Stephen Mallette added a comment - ha - might be over-thinking but it's not a bad line of over-thinking. i thought about namespacing the TinkerPop plugins, but didn't do that for some plugin-type things in gremlin server - again, saving the namespace-less names for TinkerPop. so i followed suit with plugins. that said, i'm cool with namespacing everything in the manner you describe. i agree that if we set the pattern that way from the outset it might be easier to follow for others than just using "documentation". then we don't have that little loophole to worry about.

          I'd like to see it as tinkerpop.giraph and tinkerpop.neo4j, etc. Up to you if you want to go through the laborious process of updating there and the docs.

          okram Marko A. Rodriguez added a comment - I'd like to see it as tinkerpop.giraph and tinkerpop.neo4j, etc. Up to you if you want to go through the laborious process of updating there and the docs.

          done:

          Unable to find source-code formatter for language: text. Available languages are: actionscript, ada, applescript, bash, c, c#, c++, cpp, css, erlang, go, groovy, haskell, html, java, javascript, js, json, lua, none, nyan, objc, perl, php, python, r, rainbow, ruby, scala, sh, sql, swift, visualbasic, xml, yaml
                   \,,,/
                   (o o)
          -----oOOo-(3)-oOOo-----
          plugin activated: tinkerpop.server
          plugin activated: tinkerpop.utilities
          plugin activated: tinkerpop.tinkergraph
          gremlin> :plugin use tinkerpop.sugar
          ==>tinkerpop.sugar activated
          gremlin> :plugin list
          ==>tinkerpop.server[active]
          ==>tinkerpop.gephi
          ==>tinkerpop.sugar[active]
          ==>tinkerpop.utilities[active]
          ==>tinkerpop.tinkergraph[active]
          
          spmallette Stephen Mallette added a comment - done: Unable to find source-code formatter for language: text. Available languages are: actionscript, ada, applescript, bash, c, c#, c++, cpp, css, erlang, go, groovy, haskell, html, java, javascript, js, json, lua, none, nyan, objc, perl, php, python, r, rainbow, ruby, scala, sh, sql, swift, visualbasic, xml, yaml \,,,/ (o o) -----oOOo-(3)-oOOo----- plugin activated: tinkerpop.server plugin activated: tinkerpop.utilities plugin activated: tinkerpop.tinkergraph gremlin> :plugin use tinkerpop.sugar ==>tinkerpop.sugar activated gremlin> :plugin list ==>tinkerpop.server[active] ==>tinkerpop.gephi ==>tinkerpop.sugar[active] ==>tinkerpop.utilities[active] ==>tinkerpop.tinkergraph[active]

          People

            spmallette Stephen Mallette
            okram Marko A. Rodriguez
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: