You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jena.apache.org by GitBox <gi...@apache.org> on 2021/12/13 05:21:29 UTC

[GitHub] [jena-site] kinow opened a new pull request #83: Add Citing section to site

kinow opened a new pull request #83:
URL: https://github.com/apache/jena-site/pull/83


   @afs saw this thread on the mailing list today, and thought perhaps we could add a section to the homepage too? WDYT?
   
   If that is merged, then we can think about improving it later, e.g.
   
   - Creating a DOI (useful for citations and also for tools like [CWL](https://www.commonwl.org/) which can use it when defining dependencies)
   - Add a `CITATION.cff` file to [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files)
   - Add bibtex examples in the website for users to easily copy/paste and produce the output in their papers (helpful to have a uniform citation that google scholar/researchgate/etc can index)
   
   I more or less copy-pasted one of your answers :smile: but we can edit the commit adjusting the text as needed, and also ask what others think in the mailing list.
   
   -Bruno


-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] afs commented on pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
afs commented on pull request #83:
URL: https://github.com/apache/jena-site/pull/83#issuecomment-994887039


   Thanks for doing this.
   


-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] afs commented on a change in pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
afs commented on a change in pull request #83:
URL: https://github.com/apache/jena-site/pull/83#discussion_r769722302



##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://lists.apache.org/thread/jl8npmty96j1gkflmlpx5c0kcfdjr3f6)
+
+The name of the project is “Apache Jena”. That should appear as the first
+use in a paper and in a reference. After that "Jena" can be used.
+It is also a [trademark](https://www.apache.org/foundation/marks/#books)
+of the Apache Software Foundation. This is also the industry practice.
+
+The reference should indicate the website <https://jena.apache.org/>
+(`https` is preferable). If relevant to reproducibility, or discussing
+performance, the release version number **MUST** also be included. The date

Review comment:
       IMO: A bit shouty. "must" is enough.

##########
File path: layouts/_default/baseof.html
##########
@@ -120,6 +120,7 @@
                         <li class="divider"></li>
                         <li class="dropdown-header">Project</li>
                         <li><a href="/about_jena/about.html">About Jena</a></li>
+                        <li><a href="/about_jena/citing.html">Citing</a></li>

Review comment:
       (It isn't showing in the staged build for me - should PRs from other repos show up there?)
   
   I doubt people that don't search hard enough will look in a dropdown. Or look at the site :-) Best we can hope for is Google search for "jena citation".
   
   Adding to baseof.html adds it to every page.
   
   Maybe one the "about" page is enough?




-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] afs merged pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
afs merged pull request #83:
URL: https://github.com/apache/jena-site/pull/83


   


-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] kinow commented on pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
kinow commented on pull request #83:
URL: https://github.com/apache/jena-site/pull/83#issuecomment-992304623


   Feedback addressed! Thanks @rvesse !


-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] kinow commented on a change in pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
kinow commented on a change in pull request #83:
URL: https://github.com/apache/jena-site/pull/83#discussion_r767419479



##########
File path: layouts/_default/baseof.html
##########
@@ -120,6 +120,7 @@
                         <li class="divider"></li>
                         <li class="dropdown-header">Project</li>
                         <li><a href="/about_jena/about.html">About Jena</a></li>
+                        <li><a href="/about_jena/citing.html">Citing</a></li>

Review comment:
       Added a new section, but this could also go in the About Jena section. However, I think some users would miss it (or not search hard enough) and ask in the mailing list anyway?




-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] rvesse commented on a change in pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
rvesse commented on a change in pull request #83:
URL: https://github.com/apache/jena-site/pull/83#discussion_r767554701



##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://markmail.org/thread/k2hwm7m4c4dlo6ff)
+
+The name of the project is “Apache Jena”. That should appear as the first
+use in a paper and in a reference. After that "Jena" can be used.
+It is also a [trademark](https://www.apache.org/foundation/marks/#books)
+of the Apache Software Foundation. This is also the industry practice.
+
+The reference should indicate the website <https://jena.apache.org/>
+(`https` is preferable). If relevant to reproducibility the release
+version number can also be included. The date of access would also

Review comment:
       `can` -> `**MUST**`

##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://markmail.org/thread/k2hwm7m4c4dlo6ff)

Review comment:
       Can we use a `lists.apache.org` permalink instead?

##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://markmail.org/thread/k2hwm7m4c4dlo6ff)
+
+The name of the project is “Apache Jena”. That should appear as the first
+use in a paper and in a reference. After that "Jena" can be used.
+It is also a [trademark](https://www.apache.org/foundation/marks/#books)
+of the Apache Software Foundation. This is also the industry practice.
+
+The reference should indicate the website <https://jena.apache.org/>
+(`https` is preferable). If relevant to reproducibility the release
+version number can also be included. The date of access would also
+be helpful to the reader.
+
+You can use names such as “TBD” and “Fuseki” on their own. They are informal

Review comment:
       Typo `TBD` -> `TDB`

##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://markmail.org/thread/k2hwm7m4c4dlo6ff)
+
+The name of the project is “Apache Jena”. That should appear as the first
+use in a paper and in a reference. After that "Jena" can be used.
+It is also a [trademark](https://www.apache.org/foundation/marks/#books)
+of the Apache Software Foundation. This is also the industry practice.
+
+The reference should indicate the website <https://jena.apache.org/>
+(`https` is preferable). If relevant to reproducibility the release

Review comment:
       After reproducibility, add `, or discussing performance,`




-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] kinow commented on a change in pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
kinow commented on a change in pull request #83:
URL: https://github.com/apache/jena-site/pull/83#discussion_r767577086



##########
File path: source/about_jena/citing.md
##########
@@ -0,0 +1,33 @@
+---
+title: Citing Jena
+---
+
+[comment]: <> (https://markmail.org/thread/k2hwm7m4c4dlo6ff)

Review comment:
       Force of habit. Had a look at lists.apache.org and liked the interface! Will try to start using that now. Thanks!




-- 
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: dev-unsubscribe@jena.apache.org

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



[GitHub] [jena-site] rvesse commented on pull request #83: Add Citing section to site

Posted by GitBox <gi...@apache.org>.
rvesse commented on pull request #83:
URL: https://github.com/apache/jena-site/pull/83#issuecomment-995196050


   @afs I think the way I got the staging builds set up right now effectively every PR is publishing to the same staged site so it's a race condition problem, whichever PR gets built most recently is the one that publishes the staging site.
   
   An alternative setup we can explore is that each branch/PR would create a unique staging site instead


-- 
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: dev-unsubscribe@jena.apache.org

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