manual_teachbooks/book/workflows/collaboration.md
Tom van Woudenberg e7602fc485 Restructured toc
2024-04-10 12:07:49 +02:00

765 B

Collaborative book-editing

As previously mentioned there are multiple platforms that can host Git repositories which are extremely useful for collaboration on text-based files. Here we will elaborate on two: GitLab and GitHub both in the online environment and locally.

Globally, the steps involved are as follows:

  1. Define issue to work on
  2. Open the files of the repository online or clone the repository to work on it locally
  3. Create a branch for your changes
  4. Edit the book by:
    • Pulling remote changes from others
    • Staging your changes
    • Commit a collection of changes
    • If working on a repository locally: pushing your changes
  5. Reviewing and merging changes in a merge request
  6. Publish changes to published version of book