Skip to content

Cadasta Docs Guide for Employees

Jump to bottom
Beth Schechter edited this page Jul 25, 2017 · 1 revision

Overview

Are you a Cadasta employee seeking to use or update documentation and training materials? This is the documentation for you.

This documentation was also created rather quickly, so please pardon brevity.

The main items covered are:

Note that this documentation assumes some knowledge of common versioning and Github conventions. If you’re unfamiliar with versioning and Github in general, please ask a member of the development team for a rundown.

Also note that Google Drive files linked here are in the Cadasta Organizational Files folder. You should be able to access this using your Cadasta account. Please contact one of the following people if you need access:

docs.cadasta.org

These documents are stored on Github and displayed using Gitbooks. Gitbooks is an application that works on top of GitHub. You can edit the documents in GitBooks, or in your favorite text editor. Try both and see which you like best!

Writing docs

Cadasta documentation is written using Markdown, a simplified version of HTML. This allows for documentation to easily work with GitHub, affording Cadasta ample version control.

English

The master copy of the documentation is written in English and can be found at docs.cadasta.org/en. Note that the appropriate assets folder (for images) is in the en folder.

Translating from English

You can translate the documentation using an application called CrowdIn. You can see the Cadasta project there at this URL: https://crowdin.com/project/cadasta-docs

Katrina and David are admins for CrowdIn the email address for the account is [email protected] which both have access to.

The workflow with Crowd In is people translate on the Crowd In site and then a manager needs to “build” the project. Building updates the branch “l10n_master”. You then need to merge to Master in Github to add the translations to Gitbooks.

Updating Images

At some point, the images will need to be updated (particularly as the platform is updated). Many of the images have been created in Illustrator (to add pointers and arrows to important features) and would need to be created from scratch.

An easier alternative exists, however, with the training materials described below: as the slides are updated, you create new images. Make your life easier by updating the images in the training materials first, and then using those images to update the documentation.

In general, making images in Google Slides makes it easy to add arrows to screenshots and then export to images. Here’s an example of what I mean: https://docs.google.com/presentation/d/1zjEAEEZWmx4sIYT1svrNISQszkXD39yfmmGN6XEtX00/edit#slide=id.g1f9fdf2a52_0_14

API Documentation

Please direct questions about the API Documentation to Oliver Roick: [email protected]

Demo Videos (Youtube)

These videos were created using Camtasia. Should you need to edit the original files, please contact [email protected]. They are quite large, so she (I) didn’t load then to drive.

Training Materials (Google Slides)

These materials, created in the summer of 2017, are designed so that the Programs teach can easily update and remix the materials as needed.

Using the Training Materials

  1. Make a copy of the Master Version
  2. Add and remove materials as needed on the new version.
  3. If you’re presenting in an area with limited connectivity, download a PDF or .PPT while you’re still near WiFi

Updating the Training Materials.

  1. Save a version of the Master, if you like, in the _Deprecated Master folder
  2. Edit Master and review as needed.
Clone this wiki locally