First of all, you are welcome to email the Documentation Listserv (firstname.lastname@example.org) with problems you find in the documentation. However, we welcome you to participate in the process of improving things. Below are various ways you can contribute your time and skills.
We use Git for version control on documentation. The official repository is housed on the Evergreen git server git.evergreen-ils.org. However, we will continue to use the github repository for authoring and editing documentation since it provides more editing options and a few extra features.
Note: Changes to the github documentation will be added to the official repository (git.evergreen-ils.org) and processed into HTML and PDF nightly at 11pm.
Note: The documentation is now hosted in the main Evergreen github repository (github.com/evergreen-library-system/Evergreen), rather than the repositories mentioned below.
Editing files directly in github using the following procedures is not recommended for larger changes, but is useful for quick typo corrections and other minor edits. Please be extra-careful to keep the XML formatting valid, as a mistake can prevent the chapter from updating (don't touch any tags)! If you need to make major changes, either install git on your own machine (directions follow), or send changes to the DIG list.
Edit this file
Commitmessage box and click
Command line (Linux, or GitBash on Windows): Type
git clone email@example.com:ysuarez/Evergreen-DocBook.git to create an initial copy of the repository on your machine. You will need to enter your SSH passphrase.
GitGui on Windows (recommended if you are not comfortable with the command line): On launch, click Clone Existing Repository. In “Source”, put
firstname.lastname@example.org:ysuarez/Evergreen-DocBook.git; leave “Target” blank to use the default path, or enter something else (it creates a new directory, so don't use one that exists already). Click Clone. You will be prompted for your SSH passphrase.
Note: If you get an error message with the email@example.com clone source, use
git://github.com/rsoulliere/Evergreen-DocBook.git instead. Then edit the
config file in the .git directory (top level of your cloned repository, ie Evergreen-DocBook) and change the value for
url (in the
[remote “origin”] section) to
git pull- Pulls the most recent changes into your cloned version. This avoids merging issues and errors when “pushing” your changes to the remote repository.
git add- Tells git that you have added or edited files on your local machine and want to add them into the repository. The changes are not commited yet.
git commit path/filenameOR
git commit path/filename -m ”[what you changed]”- Commits changes to the repository. A note on what you changed is mandatory. If you use the shorter form, you will be put into a text editor (usually vim) to compose your note. (Using the -m switch is a time-saver!) To commit all changes, use
git commit ..
git push- Push your changes to the remote repository. After pushing your changes you should see them show up at https://github.com/ysuarez/Evergreen-DocBook/commits/master.
Unstaged Changes(red). Click a file to see color-coded changes in the pane to the right.