Re: documentation for player/stage

On Tue, Jun 16, 2015 at 6:53 PM, Dr. Kevin Nickels <[email protected]>
wrote:

> +1 on github for the code.
>
> I'm interested in the documentation discussion - I've been slowly updating
> Jenny Owen's tutorial (with her till she got a "real job").
>
> I found that LaTeX isn't the best for collaboration (i.e. I can't have any
> of my undergrad research students edit it directly), so we've been putting
> it into github markdown, now I'm wondering if that was the best choice :)
>

If you are moving out of latex, I would recommend  RST (ReStructured Text).
There is a lot of good things with rst such as using sphinx docs, convert
to latex/pdf/ and more.

you can also host them on readthedocs.org

Anyway it is upto the devs, just my +1 for rst

>
> It's now at https://github.com/NickelsLab/Player-Stage-Manual, if anyone
> wants to start picking at it.  The python chapters are not complete, but
> all the stuff in Version 4 of the manual (which uses player-3.0.2 and
> stage-4.1.1) is all there.  My current student is past the player/stage
> learning phase and is into application research - so this is now a
> spare-time project.  As Rich says, I'll get to it as I have time :)
>
> --kn
>
> On Wed, Jun 10, 2015 at 10:39 PM, Rich Mattes <[email protected]> wrote:
>
>> Alright I got the Player code imported and invited a few people to the
>> new github organization.  I will grab the "www" and "papers" folders out
>> of svn and set up repositories under playerproject for each of them.
>>
>> Github will let us host a page at playerproject.github.io, but it won't
>> let us use php.  I can restructure the playerstage.sf.net site to be
>> flat html instead of using php, which wouldn't be too hard.  I can also
>> use some space on my personal webserver to host the site, which will let
>> us not have to mess with the site, and will let us import and keep
>> running mediawiki with all the wiki spam that entails.  I think we can
>> worry about that later though.
>>
>> I have noticed a lot of people using readthedocs.org as well, and also
>> have no idea how that works.  I'll look into that for the doxygen
>> documentation.
>>
>> Rich
>>
>> On 06/10/2015 10:21 PM, BiggsGeoffrey wrote:
>> > An excellent plan, Rich.
>> >
>> > I agree that the code is the priority. For the website, etc., they will
>> still be usable from SF until SF decides to coopt the project. What about
>> putting the website and so on in a branch for now until you have time to
>> look at them?
>> >
>> > One possibly for the API docs is readthedocs.org. I have absolutely no
>> idea how they operate, but I seem to be increasingly directed there for
>> documentation.
>> >
>> > Geoff
>> > ________________________________________
>> > From: Brian Gerkey <[email protected]>
>> > Sent: Thursday, 11 June 2015 10:08 a.m.
>> > To: [email protected]
>> > Subject: Re: [Playerstage-developers] Is player dead?
>> >
>> > Ditto, +1 to that plan.
>> >
>> > On Wed, Jun 10, 2015 at 6:05 PM, Richard Vaughan <[email protected]>
>> wrote:
>> >> Thanks Rich. Github makes sense to me too. Thanks for working on this.
>> >>
>> >> R/
>> >>
>> >> On Wed, Jun 10, 2015 at 5:35 PM, Rich Mattes <[email protected]> wrote:
>> >>>
>> >>> Hi all,
>> >>>
>> >>> First, yes, I am still maintaining Player and I'm happy to accept
>> >>> patches and field bug reports.  It's not under active development
>> >>> anymore, but it's not dead by any means.  I've been chipping away at
>> >>> things here and there, like updating drivers to support new library
>> >>> versions and updating the xdr and interface generation scripts to work
>> >>> with python 3.
>> >>>
>> >>> I'm glad this thread has popped up, as I've been thinking about the
>> >>> sourceforge hosting situation for the past few days, and  addressing
>> it
>> >>> has been quickly moving up my to-do list.  About a year or two ago I
>> >>> worked out the proper git-svn incantation and username/email address
>> >>> mappings to export the entire Player svn repository history into git.
>> >>> I'll try to dig that up again and see if I can get the tree and the
>> >>> history into git locally.
>> >>>
>> >>> Github and Bitbucket are both good choices for a new host, though I
>> lean
>> >>> towards github because it's a lot more popular.  My gameplan is to set
>> >>> up a github organization called "playerproject" to host the code
>> under,
>> >>> and create a "player" repository underneath for the Player code.
>> Once I
>> >>> push the git tree, I'll add whichever of you would like to be part of
>> >>> the new github org and look at migrating the issues, wiki, website,
>> api
>> >>> docs, etc. from sf and tagging a 3.1 release under the new
>> >>> infrastructure.  I don't have a lot of time for the rest of this
>> month,
>> >>> but I think I can at least get the code moved, and worry about the
>> rest
>> >>> once I get some more free time.
>> >>>
>> >>> Rich
>> >>>
>> >>> On 06/10/2015 07:05 PM, BiggsGeoffrey wrote:
>> >>>> I think that they already have melted down. The recent incident with
>> SF
>> >>>> taking over the GIMP Windows project and bundling adware in the
>> >>>> installer was not an isolated incident.
>> >>>>
>> >>>>
>> >>>> Github would seem to be the logical choice at the moment, but I think
>> >>>> that any migration destination should be driven by Rich's needs, to
>> >>>> ensure he can maintain it easily.
>> >>>>
>> >>>>
>> >>>> Geoff
>> >>>>
>> >>>>
>> >>>>
>> ------------------------------------------------------------------------
>> >>>> *From:* Richard Vaughan <[email protected]>
>> >>>> *Sent:* Thursday, 11 June 2015 3:04 a.m.
>> >>>> *To:* [email protected]
>> >>>> *Subject:* Re: [Playerstage-developers] Is player dead?
>> >>>> Seconding Brian's answer. Player and Stage are mature and in
>> maintenance
>> >>>> mode. Rich is accepting patches that fix bugs, etc. but may not
>> respond
>> >>>> as quickly as in past years. The code remains available and always
>> will.
>> >>>>
>> >>>> By the way, we might want to migrate Player away from SourceForge
>> before
>> >>>> they melt down completely.
>> >>>>
>> >>>> Richard/
>> >>>>
>> >>>>
>> >>>> On Wed, Jun 10, 2015 at 10:35 AM, Brian Gerkey <[email protected]
>> >>>> <mailto:[email protected]>> wrote:
>> >>>>
>> >>>>      hi Fred,
>> >>>>
>> >>>>      It's awesome to hear that you're still using Player.  We put a
>> lot
>> >>>> of
>> >>>>      effort into that tool for many years.
>> >>>>
>> >>>>      It's fair to say that Player is no longer under active
>> development,
>> >>>>      but that doesn't mean that it's dead.  I handed over
>> responsibility
>> >>>>      for Player to the very capable Rich Mattes several years ago,
>> when I
>> >>>>      turned my attention to ROS.  I think that Rich is still applying
>> >>>>      patches.  Looks like this is the place to submit them:
>> >>>>      http://sourceforge.net/p/playerstage/patches/
>> >>>>
>> >>>>      brian.
>> >>>>
>> >>>>      On Wed, Jun 10, 2015 at 8:32 AM, Fred Labrosse <[email protected]
>> >>>>      <mailto:[email protected]>> wrote:
>> >>>>      > All,
>> >>>>      >
>> >>>>      > Sorry for the blunt question, but do I sense that player is
>> dying?
>> >>>>      >
>> >>>>      > I’m asking because I am still using it, but see very little
>> >>>> traffic on either mailing list and very few commits made to the svn
>> >>>> repository.  I have a few diffs to submit that have to do with ptz
>> >>>> interfaces and the sonyevid30 driver and I was wondering if  there
>> was any
>> >>>> point in submitting them.
>> >>>>      >
>> >>>>      > Player has been very useful to me for many years, and I would
>> hate
>> >>>> seeing it disappear, especially since changing to something else,
>> such as
>> >>>> ROS, would be quite some work for me to port some of our player code
>> to the
>> >>>> new system.
>> >>>>      >
>> >>>>      > Any views on that?
>> >>>>      >
>> >>>>      > Cheers,
>> >>>>      >
>> >>>>      > Fred
>> >>>>      >
>> >>>>      >
>> >>>>      >
>> >>>>
>> ------------------------------------------------------------------------------
>> >>>>      > _______________________________________________
>> >>>>      > Playerstage-developers mailing list
>> >>>>      >[email protected]
>> >>>>      <mailto:[email protected]>
>> >>>>      >
>> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >>>>
>> >>>>
>> >>>>
>> ------------------------------------------------------------------------------
>> >>>>      _______________________________________________
>> >>>>      Playerstage-developers mailing list
>> >>>>      [email protected]
>> >>>>      <mailto:[email protected]>
>> >>>>
>> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >>>>
>> >>>>
>> >>>>
>> >>>>
>> >>>>
>> >>>>
>> ------------------------------------------------------------------------------
>> >>>>
>> >>>>
>> >>>>
>> >>>> _______________________________________________
>> >>>> Playerstage-developers mailing list
>> >>>> [email protected]
>> >>>> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >>>>
>> >>>
>> >>>
>> >>>
>> ------------------------------------------------------------------------------
>> >>> _______________________________________________
>> >>> Playerstage-developers mailing list
>> >>> [email protected]
>> >>> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >>
>> >>
>> >>
>> >>
>> ------------------------------------------------------------------------------
>> >>
>> >> _______________________________________________
>> >> Playerstage-developers mailing list
>> >> [email protected]
>> >> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >>
>> >
>> >
>> ------------------------------------------------------------------------------
>> > _______________________________________________
>> > Playerstage-developers mailing list
>> > [email protected]
>> > https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >
>> >
>> ------------------------------------------------------------------------------
>> > _______________________________________________
>> > Playerstage-developers mailing list
>> > [email protected]
>> > https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>> >
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Playerstage-developers mailing list
>> [email protected]
>> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>>
>
>
>
> --
> Kevin Nickels <[email protected]>
> http://www.trinity.edu/knickels 210-999-7543
> Associate Professor, Engineering Science, Trinity University
> Center for Sciences and Innovation (CSI), Rm 470Q, San Antonio TX
> 78212-7200
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Playerstage-developers mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/playerstage-developers
>
>


-- 
Regards,
   Rashad

------------------------------------------------------------------------------

_______________________________________________
Playerstage-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/playerstage-developers