capstone-projects/pipeline.md

# Ebook Update Pipeline Project

## Background

Libraries would like to get free ebooks into their catalogs, but too often, their information is out of date. Many ebook authoring systems allow the books to be continually updated; this is especially true of software documentation books which are updated along with the software they document.

There needs to be a way for ebook authors to announce new books and version updates to distributors, aggregators and libraries and to provide these distribution channels with the metadata and files they need to promote and distrute these books.

## Plan
This project will create an update pipeline for these ebooks by implementing update hooks in a variety of open source ebook authoring systems. The Free Ebook Foundation has demonstrated the viability of such a system in its GITenberg project, which uses Github hooks to announce the possible availability of an updated version of a book built from a git repository, and YAML-based metadata files to describe the ebooks being updated.

### Team
This project will attempt to scale this approach by implementing update hooks in a number of open-source ebook authoring tools. As the tools are based on different software environments, this project will need a team with a variety of programming skills.

#### Members
    * fill in team members *
 - name  
 - name
 - name
 - name
 - name

#### About the Team
    * fill in team attributes *

### Objectives
Ebook authoring systems the team will target:
 - Wikibooks (PHP)
 - Gitbooks (Node/Javascript)
 - Pressbooks/Rebus (PHP)
 - Readthedocs (Python)
 - Standard Ebooks (Python)
 - Bookdown (R)

The update server will then use Unglue.it to provide syndication feeds for downstream consumption.

### Issues
Issues the team will need to resolve

 - metadata format and dictionary
 - versioning and duplicates
 - authenticating users and preventing spam

### Wrap-up
Finally the team will produce how-to documentation to enable other ebook-building systems to add update hooks to their own systems.

### Schedule

 - mid May, 2019 -  Press Release!
add note about a how-to 2018-08-15 19:44:10 +00:00			`# Ebook Update Pipeline Project`
initial commit 2018-08-15 17:34:24 +00:00
formatting 2018-08-15 17:43:49 +00:00			`## Background`
initial commit 2018-08-15 17:34:24 +00:00
			`Libraries would like to get free ebooks into their catalogs, but too often, their information is out of date. Many ebook authoring systems allow the books to be continually updated; this is especially true of software documentation books which are updated along with the software they document.`

formatting 2018-08-15 17:43:49 +00:00			`There needs to be a way for ebook authors to announce new books and version updates to distributors, aggregators and libraries and to provide these distribution channels with the metadata and files they need to promote and distrute these books.`

			`## Plan`
initial commit 2018-08-15 17:34:24 +00:00			`This project will create an update pipeline for these ebooks by implementing update hooks in a variety of open source ebook authoring systems. The Free Ebook Foundation has demonstrated the viability of such a system in its GITenberg project, which uses Github hooks to announce the possible availability of an updated version of a book built from a git repository, and YAML-based metadata files to describe the ebooks being updated.`

headings in plan 2018-08-15 21:47:57 +00:00			`### Team`
initial commit 2018-08-15 17:34:24 +00:00			`This project will attempt to scale this approach by implementing update hooks in a number of open-source ebook authoring tools. As the tools are based on different software environments, this project will need a team with a variety of programming skills.`

add slot for team members 2018-08-15 21:49:53 +00:00			`#### Members`
name change 2018-08-24 15:54:54 +00:00			`* fill in team members *`
			`- name`
add slot for team members 2018-08-15 21:49:53 +00:00			`- name`
			`- name`
			`- name`
			`- name`
name change 2018-08-24 15:54:54 +00:00
			`#### About the Team`
			`* fill in team attributes *`
add slot for team members 2018-08-15 21:49:53 +00:00
headings in plan 2018-08-15 21:47:57 +00:00			`### Objectives`
initial commit 2018-08-15 17:34:24 +00:00			`Ebook authoring systems the team will target:`
			`- Wikibooks (PHP)`
			`- Gitbooks (Node/Javascript)`
			`- Pressbooks/Rebus (PHP)`
			`- Readthedocs (Python)`
			`- Standard Ebooks (Python)`
			`- Bookdown (R)`

add note about a how-to 2018-08-15 19:44:10 +00:00			`The update server will then use Unglue.it to provide syndication feeds for downstream consumption.`

headings in plan 2018-08-15 21:47:57 +00:00			`### Issues`
			`Issues the team will need to resolve`

			`- metadata format and dictionary`
			`- versioning and duplicates`
name change 2018-08-24 15:54:54 +00:00			`- authenticating users and preventing spam`
headings in plan 2018-08-15 21:47:57 +00:00
add slot for team members 2018-08-15 21:49:53 +00:00			`### Wrap-up`
proposal process and date 2018-08-27 21:21:14 +00:00			`Finally the team will produce how-to documentation to enable other ebook-building systems to add update hooks to their own systems.`

			`### Schedule`

			`- mid May, 2019 - Press Release!`