yade-dev team mailing list archive

[Robert Caulk <rcaulk@xxxxxxxxxxxx>]

Thank you, everyone, for so much for your feedback.

I agree with the general consensus that we want to keep the sphinx docs in
first priority, and possibly include white papers as part of the doc.
@Jérôme, actually yes, that is a good example of the type of outlet I'd
like Yade to offer :-)

Since we all seem to support this initiative, I've taken the next few steps:

*1.*  I've attached a latex template that we can use for consistent
document formatting. Please take a look at this template and send back any
and all changes you wish to make to it.  *All suggestions/changes welcome! *

*2.*  The name. "Yade Technical Archive" is just a placeholder at this
point. If you have any suggestions for the name, please send it my way.
Here are a couple ideas:

   - Yade Technical Papers
   - Yade White Paper Archive

*all other suggestions/variations welcome!*

*3.* CrossRef. I looked into becoming a member and there are a few caveats:

   - $275 annual membership fee (lowest non-profit organization membership
   price)
      - how will we pay this? Who pays for our website hosting and buildbot
      slave costs?
   - $1 one time fee per article submitted for DOI
      - how will we pay this? Do we charge the submitter?
   - Are these prices worth it for DOI?
      - Maybe, DOI maintains our article metadata for us in a searchable
      database used by most other publications (and google scholar).
   - If we decide to apply to become a member of CrossRef, we need 3 people
   to volunteer for the following positions:
      - Business contact
         - (receives product and service information)
      - Technical contact
         - (responsible for fixing any metadata errors, metadata quality
         contact)
      - Billing contact
         - (receives and pays the fees)

*4.* Yade website addition:

   - Should we add a new link to the homepage under documentation?
   - Should we just keep the documents in the references list?
      - Special "Yade Technical Archives" references subsection?
   - Both?


I appreciate your continued feedback! I think this will open up a nice
public relations avenue for Yade if we are able to move forward with it.

Cheers,

Robert




On Wed, Feb 7, 2018 at 8:25 AM, Janek Kozicki (yade-dev) <janek_listy@xxxxx>
wrote:

> Hi Robert,
>
> I think that it’s a great idea. Especially if we could use it to directly
> improve the documentation. I suppose that virtually everything that we
> could write about using yade could be somehow fit into the sphinx docs.
> Like in Jerome said, my specific answers to two of your questions are "no”
> at the moment. Mostly because whatever I do, I plan to release it either as
> a paper, or on the documentation. However some specific scripts to
> calculate this, or that - they usually grow organically over time, and I
> guess that those would fit greatly into what you are proposing to do.
>
> best regards
> Janek
>
> On 5 Feb 2018, 16:40 +0100, Bruno Chareyre <bruno.chareyre@xxxxxxxxxxxxxxx>,
> wrote:
>
> Hi Robert,
>
> On 02/02/2018 07:37 PM, Robert Caulk wrote:
>
> Hey Yade Devs,
>
> I am wondering if we have the demand to create a Yade related white
> paper publication. The publication would document very Yade specific
> functionalities and I imagine some papers might even highlight pieces
> code. I think the format would be very flexible, some releases might
> be 3 pages with brief summary and figures, while others might be
> formatted similarly to a conference paper. In all cases, I think we
> could maintain a quality archive by incorporating CrossRef, reviewing
> the writing/work, and laying out the documents consistently.
>
> I think it makes complete sense, I would support the initiative, thanks.
> I would point out one risk though: it may distract one from writing an
> actual documentation (with sphinx) while we know that writing the doc is
> of highest importance.
> I feel that the benefits could be more than the risk, but the issue
> should be kept in mind. Actually the possibility of converting some of
> these white papers into sphinx documents (to be included directly as doc
> pages) could be systematically considered, and the white paper could be
> just a step in that direction.
>
> This page is a good example of a short paper that was converted into a
> doc page.
> https://yade-dem.org/doc/FEMxDEM.html
>
> I think you know this one to: ;)
> https://yade-dem.org/doc/amazonEC2.html
>
> Bruno
>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~yade-dev
> Post to : yade-dev@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~yade-dev
> More help : https://help.launchpad.net/ListHelp
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~yade-dev
> Post to     : yade-dev@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~yade-dev
> More help   : https://help.launchpad.net/ListHelp
>
>