You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by GitBox <gi...@apache.org> on 2021/07/31 13:15:20 UTC

[GitHub] [tinkerpop] OyvindSabo opened a new pull request #1457: TINKERPOP-2591: Make administrative adjustments to gremlint site

OyvindSabo opened a new pull request #1457:
URL: https://github.com/apache/tinkerpop/pull/1457


   https://issues.apache.org/jira/browse/TINKERPOP-2591
   
   **Install gremlint from npm rather than from OyvindSabo/gremlint**
   Previously the gremlint website installed the gremlint library from the old gremlint repo (OyvindSabo/gremlint). Now that it's available on npm it can be installed from there.
   
   **Add footer displaying current gremlint version and copyright notice**
   The footer is always positioned below the view content of the website, but it sticks to the bottom of the screen if there is not enough content to push it out of the screen. I avoided using any of the approaches which depend on a fixed footer height, as that could cause weird behavior for users with narrow screens where the footer text wraps.
   ![image](https://user-images.githubusercontent.com/25663729/127740210-5ae285e3-774b-4c70-acbc-68732acffad7.png)
   ![image](https://user-images.githubusercontent.com/25663729/127741042-e21636f4-2374-4236-8d95-1816e2e2979a.png)
   
   The gremlint version is pulled from the `package-lock.json` file. Displaying the version from `package-lock.json` instead of `package.json`, for instance, enables us to display the version as `5.3.1` while still specifying it as `^5.3.1` in `package.json`. In apps created using Create React App (as the gremlint website is) only files inside the `src` folder are considered when running or building the app. To be able to access the gremlint version from `package-lock.json` I used `customize-cra` (a tool used to override and extend the default Create React App scripts) to include `package-lock.json` in the files considered to be part of the module, hence the new `config-overrides.js` file.
   
   **Testing:**
   Tested that both `npm start` and `npm run build` still works in `docs/gremlint`.
   Tested that the whole TinkerPop website can still be built with `bin/generate-home.sh` and run by `npx serve target/site/home`.
   
   VOTE +1


-- 
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-unsubscribe@tinkerpop.apache.org

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



[GitHub] [tinkerpop] OyvindSabo merged pull request #1457: TINKERPOP-2591: Administrative adjustments to gremlint site

Posted by GitBox <gi...@apache.org>.
OyvindSabo merged pull request #1457:
URL: https://github.com/apache/tinkerpop/pull/1457


   


-- 
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-unsubscribe@tinkerpop.apache.org

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



[GitHub] [tinkerpop] spmallette commented on pull request #1457: TINKERPOP-2591: Administrative adjustments to gremlint site

Posted by GitBox <gi...@apache.org>.
spmallette commented on pull request #1457:
URL: https://github.com/apache/tinkerpop/pull/1457#issuecomment-891118999


   VOTE +1


-- 
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-unsubscribe@tinkerpop.apache.org

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



[GitHub] [tinkerpop] spmallette commented on a change in pull request #1457: TINKERPOP-2591: Administrative adjustments to gremlint site

Posted by GitBox <gi...@apache.org>.
spmallette commented on a change in pull request #1457:
URL: https://github.com/apache/tinkerpop/pull/1457#discussion_r681067643



##########
File path: docs/gremlint/package.json
##########
@@ -11,8 +11,10 @@
     "@types/node": "^12.0.0",
     "@types/react": "^16.9.53",
     "@types/react-dom": "^16.9.8",
-    "gremlint": "github:OyvindSabo/gremlint#master",
+    "customize-cra": "^1.0.0",
+    "gremlint": "^3.5.1",

Review comment:
       the only part in my mind where it gets tricky is with the release process, but i think you have it right. when we release 3.5.2 we dont' publish docs until after we'd have deployed that artifact to npm at which point we'd get the newer version to be live on the website at gremlint.com. 




-- 
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-unsubscribe@tinkerpop.apache.org

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



[GitHub] [tinkerpop] OyvindSabo commented on a change in pull request #1457: TINKERPOP-2591: Administrative adjustments to gremlint site

Posted by GitBox <gi...@apache.org>.
OyvindSabo commented on a change in pull request #1457:
URL: https://github.com/apache/tinkerpop/pull/1457#discussion_r680359324



##########
File path: docs/gremlint/package.json
##########
@@ -11,8 +11,10 @@
     "@types/node": "^12.0.0",
     "@types/react": "^16.9.53",
     "@types/react-dom": "^16.9.8",
-    "gremlint": "github:OyvindSabo/gremlint#master",
+    "customize-cra": "^1.0.0",
+    "gremlint": "^3.5.1",

Review comment:
       I set the gremlint version to `^3.5.1` for now, as opposed to `^3.5.1-alpha1` or `^3.5.1-rc1` as I wasn't sure which convention we were going with and also not sure if we would actually want the website to use the alpha versions.:thinking:




-- 
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-unsubscribe@tinkerpop.apache.org

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