4. How to Create a New Project#

A project consists of a collection of OPE books and associated container images.

Before you create a project, an empty repository for the project should already be created.

Assuming that you are using github or gitlab we recommend you create a new organization for your project. If you will be publishing containers as part of your project we also recommend that you create an docker image registery organization.

We also recommend that you create a new email address that will act as the central admin address for your project. Eg. ucsls.organization@gmail.com. You can then use this as the admin and identity for all online resources of your project.

Once this is done, to create a project make sure you have properly installed the OPE CLI tool, then run the following command:

ope new_project <project name> [repo url]

If a repo url was not specified when the project was created, you can add a repo to a project by running the following command within the project directory:

ope repo_add <repository url>

Eg. ope repo_add git@github.com:myuser/opeproject.git”

This will add the repository to the current project in order to store and track all of the project content.

This will create a new directory (with the name of the project) with 3 sub directories:

  • books: This directory contains the book(s) for the project

  • containers: This directory contains the container images

  • content: This directory contains the content associated with the book(s)