[OPEN-ILS-DOCUMENTATION] Need help with proofreading some EG 2.4 documentation

Yamil Suarez ysuarez at berklee.edu
Wed Aug 7 16:39:54 EDT 2013


On Aug 6, 2013, at 12:16 PM, Dan Scott wrote:
>> 
>> 
>> For the record, I have about 28 individual Asciidoc files with 28
>> matching HTML files (plus images).
> 
> Okay, it wasn't clear how many documents you were talking about. That
> helps.
> 
>> I don't know if this approach will be worth it if I only have one or
>> two people helping me, compared to the time it will take me to set it
>> up.
> 
> Well, okay, I was considering jumping in. But if you only want one or
> two people, then I guess not.
> 

I assumed I would get only one person, hence my approach. Also I wanted to limit any up front complexities and tasks because I am swamped right now. I just wanted to share the Drobbox/Drive with the one volunteer and go.

In addition, it did not cross my mind that a developer with lots of experience with AsciiDoc and Git would be volunteering on this, with all that is on your plate. So thanks for wanting to help.



>> Also, I will probably be the only one that is using Git in this
>> group.
> 
> It will eventually have to go into git anyway, right? That said, if you
> link to the HTML / Asciidoc versions from the wiki page, then non-git
> users would be able to see what they need and their barrier of entry
> would be reduced to knowing how to edit the wiki. And git users like me
> would be able to jump in, make edits, run test builds to ensure that the
> docs were integrated and built in PDF / epub, etc.
> 

yes, I absolutely need to get this to Git, but right now I can't even build the root file so I did not want to put it in Git just yet, but very soon I will put it all in a collab branch. It looks like I have an undiscovered ASciiDoc error, but I will post about it tomorrow to see if those that are better than me inAsciiDoc can figure it out.


>> I am still a Git newbie, and it is great to see ways that
>> source control can be leveraged, while taking advantage of current
>> community practices, to make our lives easier. I will keep this
>> approach in mind for future use. 
> 
> Okay. It does seem to me that you're basically reinventing what git
> does, but via Google Drive/Dropbox, with a lot of centralized,
> person-to-person coordination. The coordination means that the effort is
> serialized so that only one or two people can work on it, rather than
> five or ten people being able to each take one or two topics and
> finishing it in a blitz. So for larger projects in the future, I think
> it would be worthwhile trying to keep things as distributed as possible.
> 

Absolutely, in the Fall I will try converting more DocBook documentation into AsciiDoc, and I hopefully will be more comfortable with Git, collab branches, etc so that we take a distributed approach. At least for those that know Git, while making it easy for those that do not know it.


> Of course, in the end just getting the work done is awesome! Thanks for
> coordinating this and having driven the conversion effort with your
> intern in the first place!

Thanks!


More information about the OPEN-ILS-DOCUMENTATION mailing list