Git guide for documentation

From Koha Wiki

Jump to: navigation, search

Contents

Introduction

This is a beginners guide to using Git - aimed at non-developers, and specifically for the documentation team.

Initial setup

Installing Git

Configuring the basic settings

Initial copy of koha-manual repository

Key concepts

Git is a version control system. That means that all the change history of a file is kept and you can go back to an earlier version at any time.

Visually, you can think of git as a tree, with nodes where all the changes are. The last node is called the "head".


The other main characteristic of Git is that it allows for collaborative work because it has a local/remote structure (think server/client of the old days).



Cover purpose of versioning, branches and commits.

Insert visual diagram to illustrate

Glossary

  • Branch:
  • Clone:
  • Fork: this is when you take a project and copy it into your own remote repository to make a parallel project. From there, you can take your fork in a totally different direction from the original project, or continue to pull and merge from the original project to keep your fork up-to-date.
A fork creates two parallel projects, just like a fork in a tree creates two trees
  • Head: this is the last node, or change, at the top of your tree
  • Merge request:
  • Origin:
  • Pull request:
  • Remote:
  • Repository:

Workflow for documentation

Cover normal work flow - creating a branch, working on changes, committing changes, merging into master, pushing up, merge requests...

Command Description
git checkout -b taigaXXXX Create a new branch for the documentation task you are working on.
git commit . Record the changes you've made
command description
command description

Fixing mistakes

Cover amending commits, resetting things, ...

Commit messages

  • Title: Taiga XXX: Short description
  • Text: Short paragraph that sucinctly describes the change

Insert links to some good examples

Link to the general Koha Git guide

Other tutorials and resources

To do