openstax / osbooks-world-history

template-osbooks

Use this repository template to create an "osbooks" repository for migration of content from CNX Archive to Github.

Full list of osbooks repositories via Github Search.

Note: "osbook(s)" repository" and "content repository" can be used interchangably

Overview of Steps

1. Create osbook repository - by using this template repository.
2. Seed osbook repository - by updating files the content synchronization pipeline looks for to sync content from archive to github.
3. Finalize osbook repository - by creating a github issue to enable syncing of content from archive to github, one osbook per github issue.

---

Create osbook repository

1. On GitHub, navigate to the main page of this repository.

2. Above the file list, click Use this template.

3. In the Owner drop-down menu, select openstax.

4. Name the Repository:

   • osbooks-book-name, if repo contains only one collection, or
   • osbooks-book-name-bundle, if repo contains more than one collection

   Note: Repository names can be changed at a later time. Description can be left blank.

5. Set repository visibility to Private.

6. Leave Include all branches unchecked, this template repository only has one branch.

7. Click Create repository from template.

Seed osbook repository

Once the content repo is created:

1. Fill out the META-INF/books.xml:

   • Should contain atleast one <book /> tag
   • Where <book /> contains:
     • slug: determined by CM
     • collection-id: col#####
     • href: "../collections/<slug>.collection.xml"

   books.xml example

   <container xmlns="https://openstax.org/namespaces/book-container" version="1">
       <book slug="college-algebra" collection-id="col11759" href="../collections/college-algebra.collection.xml" />
       <book slug="precalculus" collection-id="col11667" href="../collections/precalculus.collection.xml" />
       <book slug="precalculus-coreq" collection-id="col32026" href="../collections/precalculus-coreq.collection.xml" />
   </container>
   

2. Copy/Paste one of the following into LICENSE file:

   • CC-BY 4.0
   • CC-BY-NC-SA 4.0
   • CC-SA 4.0

3. Change permissions with manage permissions

   1. On GitHub, navigate to the main page of this repository.
   2. On top navigation tabs, click Settings.
   3. On left navigation, click Manage access.
   4. Using the Manage Acccess panel, to add:
      • @ce-all, Role: Write
      • @content-managers, Role: Admin
      • @m1yag1, Role: Admin
      • vendor, Role: Write
      • anyone, Role: Read

Finalize osbook repository

1. Navigate to Create Issue for Repo Sync

2. Title issue "Sync Content Repo <osbook-repo-name>"

3. Copy and Paste task.md into the body of issue: task.md

   ## Description
   
   ### Set up for Syncing for following Content Repo:
   Name of Content Repo: <!-- Name of Content Repo -->
   Link of Content Repo: <!-- Link to Content Repo -->
   
   ## Acceptance Criteria
   
   - [ ] [Sync pipeline set up](https://github.com/openstax/content-synchronizer#quick-start)
   - [ ]  Initial content sync is successful
   - [ ] "CE: Github Repo Stable Sync" column on [Github/POET transition plan spreadsheet](https://docs.google.com/spreadsheets/d/1qbkcpdpION-uN8GWW3zpanpunq4pjwqmVDGPOBhNW-8/edit#gid=0) is updated with hyperlink:
   - _text_: Date of first successful pipeline job
   - _link_: Link to pipeline
   
   

4. Update the following, in the issue body:

   • <!-- Name of Content Repo -->
   • <!-- Link to Content Repo -->

5. Click, Submit New Issue

Once a new issue is submitted this kicks off the workflow to sync the content and eventually get it ready for POET.

---

Resources

• Github/ POET Transition Plan (google spreadsheet)
• Content Synchronizer (github repo)
• Content Repo Migration/ Creation Process (confluence documentation)
• Full List of Osbooks Repos (github search)
• Template Repo for New Book (this github repo)
• Creating a Repository from Template (github documentation)