Skip to content

Latest commit

 

History

History
169 lines (116 loc) · 5.52 KB

index.md

File metadata and controls

169 lines (116 loc) · 5.52 KB
Raw
layout title description
page
Malfare Protocols README
Readme for the Malfare Protocols Collection

Contents

Overview

This repository contains the protocols used by Malfare at:

It aims to:

  • Make it easier to record/view changes to the protocols;
  • Ease translation burdens;
  • Allow others to use our protocols;
  • Share others' work, to reduce reinventing the wheel.

Contributing

Amazing! You might find the Styleguide useful.

## How to use me

  • The project has been built to consider multiple languages from the start (ish) (hence English-language content living in en/)

  • In case of any dispute though, for Nowhere (at least), the English language version is canonical.

  • Translations are provided to aid those with English as a Second Language.

### I'm a normal person

(not a geek or a translator)

The protocols and procedures are available through that little menu thing in the top. Hit it, then "Protocols".

As you might have guessed, this is available at malfare.goingnowhere.org.

I'm a translator

Setup

You might find it useful to install the following free software, if you've not got them already:

You might find having the MarkDown Cheat-Sheet open in a tab useful, too.

Get going

First, a quick crash-course in GitHub, which is where the content lives.

(This has been adapted from another introduction)

  • Create a GitHub account

  • Click on the FORK button in the upper right hand corner of https://github.com/goingnowhere/malfare-protocols.

  • In either a text editor you're comfortable with, or using the web interface, make the changes you want, for translations, you'll want to

    • create, if needed, a new directory for the language (use the two letters column on language codes);
    • create, within the language directory, a translation for the protocol. Also create the 'img' directory there, and a 'xml' directory;
    • translate the 'index.md' file, saving that in the language directory also as 'index.md';
    • translate the 'visio' chart (use OpenOffice Draw for this);
    • export the chart as a PNG image ("File/Export")
    • update the navigation menu file, by creating a new section similar to _includes/navigation.html (e.g. change en/adverse_weather/">Adverse weather).

  • Submit a pull request — which is a fancy way of telling us you want to make a change — by clicking on the button marked "Create a new branch for this commit and start a pull request."

  • Wait for the changes to be incorporated.

And all of this is public, which is what public media should be (and why it should all be collected together, by the public and for the public.)

Want more GitHub instructions?

See this tutorial which is more advanced than necessary for this project but will be useful should you decide to use it in the future.

Updating translations

See updating translations

### I'm a geek

Awesomes!

  • First: check you have a global gitignore to not add OS guff. Check that's sourced, too. Thanks 👍

  • Then fork the repo, clone your copy, and work from there.

  • In your fork, you might find using git-flow helpful — we'd appreciate it! (especially features)

  • When you're ready, send a PR, and we'll consider merging it :)

We like doing things via PRs.

Bundle

On the first time run, something like this might be useful:

cd malfare-protocols
bundle || gem install bundle && bundle

Testing

Running a local copy of the protocols (e.g., if you're updating things, or translating)

bundle exec jekyll serve

Directory structure

We have protocols in the form of: (foo is the individual protocol)

  • Overview document: foo/index.md
  • The drawing ("visio") in LibreOffice Draw format: foo/xml/shortname.fodg (XML-y)
  • The diagram exported as image(s): foo/img/shortname-n.png

Use LibreOffice's File/Export option to save the PNG file(s).

Colophon