[GitHub] [tinkerpop] spmallette commented on pull request #1400: TINKERPOP-2530: Transfer OyvindSabo/gremlint and OyvindSabo/gremlint.com to apache/tinkerpop/gremlint

[GitBox <gi...@apache.org>]

spmallette commented on pull request #1400:
URL: https://github.com/apache/tinkerpop/pull/1400#issuecomment-791370867


   A first thing to consider is that this change breaks the build as the RAT plugin which checks for files without appropriate license headers is complaining:
   
   > [ERROR] Failed to execute goal org.apache.rat:apache-rat-plugin:0.13:check (rat-checks) on project tinkerpop: Too many files with unapproved license: 14 See RAT report in: /home/travis/build/apache/tinkerpop/target/rat.txt -> [Help 1]
   
   Could you please try to fix that? There are two approaches:
   
   1. We err on the side of caution and generally just add the license header to everything, even, html/css files for our website
   2. If for some reason you can't do (1) then you add an exclusion to RAT [here](https://github.com/apache/tinkerpop/blob/4aed59437b0f122cc68c875bd7eb5b55443f7ea8/pom.xml#L370-L425).
   
   > Any thoughts on this folder structure?
   > Do we want to include the gremlint website code here at all or should it reside elsewhere?
   
   We keep all of our "website" things in `docs/site`. We then have a [script](https://github.com/apache/tinkerpop/blob/4aed59437b0f122cc68c875bd7eb5b55443f7ea8/bin/publish-home.sh) that publishes the contents of `site/home` along with generated documentation to Apache infrastructure. That is done with SVN. In that sense, I feel as though gremlint.com should find a home there so that "website" things sorta stay together. On that note, perhaps my thinking would be more clear if we knew how gremlin.com will exist on Apache infrastructure. As you'd said that you would be the person handling the domain transfer, perhaps you could start that process and begin a discussion with Apache about how we would host gremlint.com? All you need to do is [create a JIRA for Infra](https://issues.apache.org/jira/projects/INFRA/) to get that process started - here is an [example](https://issues.apache.org/jira/browse/INFRA-18792). You should likely reference the [VOTE thread](https://lists.apache.org/th
 read.html/r1006ed56b5d92628f3378f9baef854da6fef3f83d8492b746b467ab6%40%3Cdev.tinkerpop.apache.org%3E) we had. Once you get that created, please add the Infra JIRA to TINKERPOP-2530 for reference.
   
   I think we need to know how we would publish to gremlint.com once the transfer is done. I presume it would be in the same fashion as we currently do for our home page/docs. I suppose another option would be for gremlint to live at `http://tinkerpop.apache.org/gremlint` and then redirect to that from gremlin.com. Not sure what they would prefer for something like this. In any case, the JIRA will get that conversation going.
   
   > Would something like apache/tinkerpop/gremlint/lib and apache/tinkerpop/gremlint/website be preferable?
   
   perhaps. i've envisioned gremlint as something we publish to npm so that it can get used as a library. as such, it will need to fall under the general Maven build structure. If that is the case, then the "lib" will have to look more like the structure in `gremlin-javascript` - you might want to take a look at that modulate to see how it is setup. I don't think we need to make a final choice on this until we hear a bit from Apache Infra. 
   
   > Some files, like the README.md and package.json files have links to OyvindSabo/gremlint and OyvindSabo/gremlint.com. Also, gremlint.com still installs gremlint from github:OyvindSabo/gremlint#master. I haven't made changes to any of this for now. Would it be preferable to do that in this PR or can it be done in a follow-up PR?
   
   My suggestion would be that you keep this initial commit, which is the "base transfer" and simply push additional commits to this branch on top of it as we learn more from Infra. Therefore, feel free to push additional commits to deal with the README/package.json/etc. Another little addition to make would be to introduce gremlint in our Upgrade Documentation. You can make an entry for that [here](https://github.com/apache/tinkerpop/blob/master/docs/src/upgrade/release-3.5.x.asciidoc#upgrading-for-users). In the Upgrade Docs we call out major new features and changes so that users can get a feel for what's "new" after we release. If you'd like to draft something there, that would be good. 
   
   Finally, almost no PR is "complete" without a CHANGELOG [entry](https://github.com/apache/tinkerpop/blob/4aed59437b0f122cc68c875bd7eb5b55443f7ea8/CHANGELOG.asciidoc) - even though we pull in JIRAs and their descriptions on release, we sometimes do work that is outside of JIRA or work that requires more subtle description or greater summary than a JIRA title, so we always just add a entry to CHANGELOG.
   
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org