Git guide for documentation
From Koha Wiki
This is a beginners guide to using Git - aimed at non-developers, and specifically for the documentation team.
Configuring the basic settings
Initial copy of koha-manual repository
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
- 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.
- Head: this is the last node, or change, at the top of your tree
- Merge request:
- Pull request:
Workflow for documentation
Cover normal work flow - creating a branch, working on changes, committing changes, merging into master, pushing up, merge requests...
|git checkout -b taigaXXXX||Create a new branch for the documentation task you are working on.|
|git commit .||Record the changes you've made|
Cover amending commits, resetting things, ...
- 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
- Git versioning guide on wiki
- Create visual guide and cheat sheet, example: https://www.git-tower.com/learn/cheat-sheets/git