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.
Note: Changes to the official repository are processed into HTML, PDF and ePub nightly at 11pm. (see http://docs.evergreen-ils.org/)
Note: The documentation is now hosted in the main Evergreen git repository:
filename.adoc. This will display the HTML version of your file. Then you can proofread your document and look for anything strange.
Command line (Linux, or GitBash on Windows):
git clone git://git.evergreen-ils.org/Evergreen.gitto create an initial copy of the repository on your machine. This will clone the whole Evergreen repository, which contains the docs directory where all the documentation lives.
Graphical tool (recommended if you are not comfortable with the command line)
git://git.evergreen-ils.org/Evergreen.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.
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.
a2x FILENAME -f=epub- Converts AsciiDoc text files to other file formats (such as ePub). This will give you errors if the AsciiDoc format is incorrect. Once it succeeds, delete the output files (e.g.
rm *.epub) to prevent them from being committed along with your AsciiDoc files.
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 committed 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, a text editor will open (usually vim) where you will write your change note. (Using the -m switch is a time-saver if your note is short) To commit all changes, use
git commit ..
git push- If you are one of the few DIG members with permission to push to the master repository, do so using your SSL passphrase. After pushing your changes you should see them show up at the master repository. If you do not have permission yet, you can start the request process by contacting the current DIG meeting facilitator email@example.com. You can also push to another public repository, such as the Evergreen working repository or another host such as GitHub. Then email the DIG email list firstname.lastname@example.org with the location of your repository so they can pull your changes into master.
filename.adoc. Then you can proofread your document and look for anything strange.
Unstaged Changes(red). Click a file to see color-coded changes in the pane to the right.