Help gettting started
45 views
Skip to first unread message
James Bostock
Dec 11, 2015, 6:23:32 PM12/11/15
to GITenberg Project
Hi,
I'd like to get involved, as an editor (though I work in software so might be able to contribute on the infrastructure side of things, too), and was hoping that someone could give a quick summary of the right way to do so. I could have sworn that, in the past, I saw a page describing the steps but, this morning, I can't seem to find it. Is it just a matter of forking a given repository on GitHub, making appropriate updates and then submitting a pull request so that the changes get merged back into the master?
Regarding the editing, as I understand it there are the following tasks:
- update the source text file (e.g. by taking advantage of Unicode to replace ASCII quotes with the appropriate opening and closing quotation marks).
- Create an AsciiDoc version of same.
- Create a metadata file
On a side note, the "Get eBooks" link on the main site (http://www.gitenberg.org/) takes one to an empty page.
Regards,
James
I'd like to get involved, as an editor (though I work in software so might be able to contribute on the infrastructure side of things, too), and was hoping that someone could give a quick summary of the right way to do so. I could have sworn that, in the past, I saw a page describing the steps but, this morning, I can't seem to find it. Is it just a matter of forking a given repository on GitHub, making appropriate updates and then submitting a pull request so that the changes get merged back into the master?
Regarding the editing, as I understand it there are the following tasks:
- update the source text file (e.g. by taking advantage of Unicode to replace ASCII quotes with the appropriate opening and closing quotation marks).
- Create an AsciiDoc version of same.
- Create a metadata file
On a side note, the "Get eBooks" link on the main site (http://www.gitenberg.org/) takes one to an empty page.
Regards,
James
Eric Hellman
Dec 12, 2015, 10:31:16 AM12/12/15
to gitenber...@googlegroups.com
James,
Welcome!
As you can see, there are many loose ends in GITenberg.
The page you couldn't find is http://www.gitenberg.org/get-involved/
The source is https://github.com/gitenberg-dev/giten_site/blob/master/gitensite/apps/content/templates/get-involved.html
We're still working on the travis and metadata files so that ebooks can get made automatically. We'll update which ever repo you decide to work on so that your ebooks get built.
At this point, the most important way to contribute to the project as a whole is to help flesh out the how-to documentation. It's difficult for those of us who have been working on the infrastructure to know what needs explaining. So as you figure out how to contribute as an editor, think about how to explain it better.
It's also good that you have dev experience, because there are things that won't work, and you can help identify the bugs that should be fixed in stead of explained.
The most current repo is Huck Finn - use that as a model. https://github.com/GITenberg/Adventures-of-Huckleberry-Finn_76
Eric
--
You received this message because you are subscribed to the Google Groups "GITenberg Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to gitenberg-proj...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/gitenberg-project/056cfd4e-c0cc-4537-b7aa-4e07f806d871%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
James Bostock
Dec 13, 2015, 1:44:50 AM12/13/15
to GITenberg Project
Hi Eric,
Thanks! I had found the page that you linked to but I could have sworn that, at some point in the past, I saw a different page that had more detail than "If you would like to offer changes: fork, edit and create a Pull Request". No matter :-).
Regards,
James
Thanks! I had found the page that you linked to but I could have sworn that, at some point in the past, I saw a different page that had more detail than "If you would like to offer changes: fork, edit and create a Pull Request". No matter :-).
Regards,
James
Sam Wilson
Dec 14, 2015, 7:04:54 PM12/14/15
to gitenber...@googlegroups.com
Another spot I use when looking for things to help with is the list of
open issues (across all books):
https://github.com/search?q=state%3Aopen+user%3Agitenberg&type=Issues
Eric, where are things at with having http://gitenberg.org/books up and
running? I'd love to help but am not much of a python type. :) Is the
idea that each repo will have its own .travis build file and be built
separately? Or is there some centralised processing system? I must admit
I'm a bit confused about the particular goals... :-)
—Sam
On 2015-12-13 14:44, James Bostock wrote:
> Hi Eric,
>
> Thanks! I had found the page that you linked to but I could have
> sworn that, at some point in the past, I saw a different page that
> had
> more detail than "If you would like to offer changes: fork, edit and
> create a Pull Request". No matter :-).
>
> Regards,
>
> James
>
> On Sunday, December 13, 2015 at 2:31:16 AM UTC+11, Eric Hellman
> wrote:
>
>> James,
>>
>> Welcome!
>>
>> As you can see, there are many loose ends in GITenberg.
>>
>> The page you couldn't find is http://www.gitenberg.org/get-involved/
>>
>> T [4]he source
>> is https://github.com/gitenberg-dev/giten_site/blob/master/gitensite/apps/content/templates/get-involved.html
>> [5]
>>> For more options, visit https://groups.google.com/d/optout [3].
> [7].
> For more options, visit https://groups.google.com/d/optout [3].
>
>
> Links:
> ------
> [1] http://www.gitenberg.org/
> [2]
>
> https://groups.google.com/d/msgid/gitenberg-project/056cfd4e-c0cc-4537-b7aa-4e07f806d871%40googlegroups.com?utm_medium=email&utm_source=footer
> [3] https://groups.google.com/d/optout
> [4] http://www.gitenberg.org/get-involved/
> [5]
>
> https://github.com/gitenberg-dev/giten_site/blob/master/gitensite/apps/content/templates/get-involved.html
> [6] https://github.com/GITenberg/Adventures-of-Huckleberry-Finn_76
> [7]
>
> https://groups.google.com/d/msgid/gitenberg-project/48def8de-da08-4131-a31e-497bb638bf2d%40googlegroups.com?utm_medium=email&utm_source=footer
open issues (across all books):
https://github.com/search?q=state%3Aopen+user%3Agitenberg&type=Issues
Eric, where are things at with having http://gitenberg.org/books up and
running? I'd love to help but am not much of a python type. :) Is the
idea that each repo will have its own .travis build file and be built
separately? Or is there some centralised processing system? I must admit
I'm a bit confused about the particular goals... :-)
—Sam
On 2015-12-13 14:44, James Bostock wrote:
> Hi Eric,
>
> Thanks! I had found the page that you linked to but I could have
> sworn that, at some point in the past, I saw a different page that
> had
> more detail than "If you would like to offer changes: fork, edit and
> create a Pull Request". No matter :-).
>
> Regards,
>
> James
>
> On Sunday, December 13, 2015 at 2:31:16 AM UTC+11, Eric Hellman
> wrote:
>
>> James,
>>
>> Welcome!
>>
>> As you can see, there are many loose ends in GITenberg.
>>
>> The page you couldn't find is http://www.gitenberg.org/get-involved/
>>
>> is https://github.com/gitenberg-dev/giten_site/blob/master/gitensite/apps/content/templates/get-involved.html
>> [5]
>>
>> We're still working on the travis and metadata files so that ebooks
>> can get made automatically. We'll update which ever repo you decide to
>> work on so that your ebooks get built.
>>
>> At this point, the most important way to contribute to the project
>> as a whole is to help flesh out the how-to documentation. It's
>> difficult for those of us who have been working on the infrastructure
>> to know what needs explaining. So as you figure out how to contribute
>> as an editor, think about how to explain it better.
>>
>> It's also good that you have dev experience, because there are
>> things that won't work, and you can help identify the bugs that should
>> be fixed in stead of explained.
>>
>> The most current repo is Huck Finn - use that as a
>> model. https://github.com/GITenberg/Adventures-of-Huckleberry-Finn_76
>> [6]
>> We're still working on the travis and metadata files so that ebooks
>> can get made automatically. We'll update which ever repo you decide to
>> work on so that your ebooks get built.
>>
>> At this point, the most important way to contribute to the project
>> as a whole is to help flesh out the how-to documentation. It's
>> difficult for those of us who have been working on the infrastructure
>> to know what needs explaining. So as you figure out how to contribute
>> as an editor, think about how to explain it better.
>>
>> It's also good that you have dev experience, because there are
>> things that won't work, and you can help identify the bugs that should
>> be fixed in stead of explained.
>>
>> The most current repo is Huck Finn - use that as a
>> model. https://github.com/GITenberg/Adventures-of-Huckleberry-Finn_76
>>
>> Eric
>>
>>> On Dec 11, 2015, at 6:23 PM, James Bostock <james....@gmail.com>
>>> wrote:
>>>
>>> Hi,
>>>
>>> I'd like to get involved, as an editor (though I work in software
>>> so might be able to contribute on the infrastructure side of things,
>>> too), and was hoping that someone could give a quick summary of the
>>> right way to do so. I could have sworn that, in the past, I saw a
>>> page describing the steps but, this morning, I can't seem to find it.
>>> Is it just a matter of forking a given repository on GitHub, making
>>> appropriate updates and then submitting a pull request so that the
>>> changes get merged back into the master?
>>>
>>> Regarding the editing, as I understand it there are the following
>>> tasks:
>>>
>>> - update the source text file (e.g. by taking advantage of Unicode
>>> to replace ASCII quotes with the appropriate opening and closing
>>> quotation marks).
>>> - Create an AsciiDoc version of same.
>>> - Create a metadata file
>>>
>>> On a side note, the "Get eBooks" link on the main site
>>> (http://www.gitenberg.org/ [1]) takes one to an empty page.
>> Eric
>>
>>> On Dec 11, 2015, at 6:23 PM, James Bostock <james....@gmail.com>
>>> wrote:
>>>
>>> Hi,
>>>
>>> I'd like to get involved, as an editor (though I work in software
>>> so might be able to contribute on the infrastructure side of things,
>>> too), and was hoping that someone could give a quick summary of the
>>> right way to do so. I could have sworn that, in the past, I saw a
>>> page describing the steps but, this morning, I can't seem to find it.
>>> Is it just a matter of forking a given repository on GitHub, making
>>> appropriate updates and then submitting a pull request so that the
>>> changes get merged back into the master?
>>>
>>> Regarding the editing, as I understand it there are the following
>>> tasks:
>>>
>>> - update the source text file (e.g. by taking advantage of Unicode
>>> to replace ASCII quotes with the appropriate opening and closing
>>> quotation marks).
>>> - Create an AsciiDoc version of same.
>>> - Create a metadata file
>>>
>>> On a side note, the "Get eBooks" link on the main site
>>>
>>> Regards,
>>>
>>> James
>>>
>>> --
>>> You received this message because you are subscribed to the Google
>>> Groups "GITenberg Project" group.
>>> To unsubscribe from this group and stop receiving emails from it,
>>> send an email to gitenberg-proj...@googlegroups.com.
>>> To view this discussion on the web visit
>>> https://groups.google.com/d/msgid/gitenberg-project/056cfd4e-c0cc-4537-b7aa-4e07f806d871%40googlegroups.com
>>> [2].
>>> Regards,
>>>
>>> James
>>>
>>> --
>>> You received this message because you are subscribed to the Google
>>> Groups "GITenberg Project" group.
>>> To unsubscribe from this group and stop receiving emails from it,
>>> send an email to gitenberg-proj...@googlegroups.com.
>>> To view this discussion on the web visit
>>> https://groups.google.com/d/msgid/gitenberg-project/056cfd4e-c0cc-4537-b7aa-4e07f806d871%40googlegroups.com
>>> For more options, visit https://groups.google.com/d/optout [3].
>
> --
> You received this message because you are subscribed to the Google
> Groups "GITenberg Project" group.
> To unsubscribe from this group and stop receiving emails from it,
> send an email to gitenberg-proj...@googlegroups.com.
> To view this discussion on the web visit
>
> https://groups.google.com/d/msgid/gitenberg-project/48def8de-da08-4131-a31e-497bb638bf2d%40googlegroups.com
> --
> You received this message because you are subscribed to the Google
> Groups "GITenberg Project" group.
> To unsubscribe from this group and stop receiving emails from it,
> send an email to gitenberg-proj...@googlegroups.com.
> To view this discussion on the web visit
>
> [7].
> For more options, visit https://groups.google.com/d/optout [3].
>
>
> Links:
> ------
> [1] http://www.gitenberg.org/
> [2]
>
> https://groups.google.com/d/msgid/gitenberg-project/056cfd4e-c0cc-4537-b7aa-4e07f806d871%40googlegroups.com?utm_medium=email&utm_source=footer
> [3] https://groups.google.com/d/optout
> [4] http://www.gitenberg.org/get-involved/
> [5]
>
> https://github.com/gitenberg-dev/giten_site/blob/master/gitensite/apps/content/templates/get-involved.html
> [6] https://github.com/GITenberg/Adventures-of-Huckleberry-Finn_76
> [7]
>
> https://groups.google.com/d/msgid/gitenberg-project/48def8de-da08-4131-a31e-497bb638bf2d%40googlegroups.com?utm_medium=email&utm_source=footer
Eric Hellman
Dec 14, 2015, 9:17:45 PM12/14/15
to gitenber...@googlegroups.com
Yes, each repo will have its own travis build file; these will be templated and propagated over all of gitenberg.
There are so many things to work on. Getting http://gitenberg.org/books up and running won't be hard, so it hasn't been a priority, but having you ask about it really helps with the inspiration.
> To view this discussion on the web visit https://groups.google.com/d/msgid/gitenberg-project/e0c671645633698a9cc7f180809b4080%40samwilson.id.au.
> For more options, visit https://groups.google.com/d/optout.
There are so many things to work on. Getting http://gitenberg.org/books up and running won't be hard, so it hasn't been a priority, but having you ask about it really helps with the inspiration.
> For more options, visit https://groups.google.com/d/optout.
James Bostock
Dec 15, 2015, 3:36:15 AM12/15/15
to GITenberg Project
Hi,
Me again. So, a precise, first step question: is one of the goals to update the text file imported from Project Gutenberg or should it be left as is. I was thinking that the order of proceedings should be:
1. Update the text file (e.g. by running the punctuation-cleanup script on it).
2. Create the AsciiDoc version from the updated text file.
Thanks,
James
Me again. So, a precise, first step question: is one of the goals to update the text file imported from Project Gutenberg or should it be left as is. I was thinking that the order of proceedings should be:
1. Update the text file (e.g. by running the punctuation-cleanup script on it).
2. Create the AsciiDoc version from the updated text file.
Thanks,
James
Eric Hellman
Dec 15, 2015, 8:57:41 AM12/15/15
to gitenber...@googlegroups.com
I think so. I wouldn't automate the application of the cleanup script over all repos though. At least not until we have a lot more experience.
To view this discussion on the web visit https://groups.google.com/d/msgid/gitenberg-project/28ef2e1f-a53b-4a27-aeff-3f196f52446a%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages