openstax / content-manager-approved-books

Store and help manage the list of OpenStax books approved for production/distribution use.

*** For user documentation please go here ***

Content Manager Approved Books

The purpose of this repository is to store and help manage the list of OpenStax books approved for production/distribution use.

Approved Books List (ABL)

The file approved-book-list.json is hand-editable and contains the list of approved_books according to the following pattern:

Git Books:

[
  {
    "repository_name": "osbooks-college-algebra-bundle",
    "style": "precalculus",
    "tutor_only": false,
    "books": [
      {
        "uuid": "13ac107a-f15f-49d2-97e8-60ab2e3b519c",
        "slug": "algebra-and-trigonometry"
      },
      {
        "uuid": "fd53eae1-fa23-47c7-bb1b-972349835c3c",
        "slug": "precalculus"
      },
      {
        "uuid": "9b08c294-057f-4201-9f48-5d6ad992740d",
        "slug": "college-algebra"
      },
      {
        "uuid": "507feb1e-cfff-4b54-bc07-d52636cecfe3",
        "slug": "precalculus-coreq"
      }
    ]
  }
]

Archive Books:

[
  {
    "collection_id": "col12067",
    "server": "cnx.org",
    "style": "u-physics",
    "tutor_only": false,
    "books": [
      {
        "uuid": "af275420-6050-4707-995c-57b9cc13c358",
        "slug": "university-physics-volume-3"
      }
    ]
  }
]

Specific versions of books in the approved_books list can be added to approved_versions:

Git Books:

[
  {
      "repository_name": "osbooks-college-algebra-bundle",
      "content_version": "1",
      "min_code_version": "20210224.204120"
  }
]

Archive Books:

[
  {
      "collection_id": "col12067",
      "content_version": "1.22.5",
      "min_code_version": "20210224.204120"
  }
]

For safety reasons, this repository cannot be pushed to directly. To make changes, one must submit a pull request and wait for tests to complete changes can be pushed to the master branch.

Distribution Usage

To access and make changes to the approved books list:

Navigate to approved-book-list.json

From here changes will be made via the GitHub user interface:

1. Select the writing utensil in the upper right corner "Edit this file"

2. The file's state will change allowing you to make edits, make changes as needed:

It would be best to make one change at a time, so that each commit will represent one change, in case changes need to be undone.

3. After changes are made scroll to the bottom of the page, to commit your changes:

• Give your change/commit a title - i.e. "Update psychology version"
• Add any additional notes
• Select "Create a new branch for this commit and create a pull request"
• Click "Commit changes"

A PR will be created for the changes made, assign a reviewer for your PR.

Once the PR is merged and the changes have been accepted. This will trigger work to be done.

Note: Every version of a book should have it's own entry.

Run Tests

$ cd content-manager-approved-books
$ npm install
$ npm run test