User's manual for Zetkin
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
_sass
assets
css
en
sv
.gitignore
CNAME
README.md
_config.yml
index.md

README.md

Zetkin User Manual

This is the Zetkin User Manual. It is powered by Jekyll and hosted by GitHub Pages at manual.zetkin.org. This README describes the status of the manual and explains how you can contribute to making it better.

Manual Outline

The Zetkin Manual is divided into four sections, describing respectively the basics of Zetkin, Zetkin from the perspective of an activist, Zetkin from the perspective of an organization official, and Zetkin from the perspective of developers.

Below is a top-level outline of the Zetkin Manual. Flag icons at each item in the list describes the translation status of that piece of the manual. No flags means the section has yet to be written.

Zetkin basics

  • Introduction πŸ‡ΈπŸ‡ͺ
  • The user account πŸ‡ΈπŸ‡ͺ
    • Forgot password πŸ‡ΈπŸ‡ͺ
    • Managing your account πŸ‡ΈπŸ‡ͺ
    • Deleting account πŸ‡ΈπŸ‡ͺ
  • The organization membership πŸ‡ΈπŸ‡ͺ
    • Connecting to an organization πŸ‡ΈπŸ‡ͺ
    • Accepting an invite πŸ‡ΈπŸ‡ͺ

For activists

  • Introduction πŸ‡ΈπŸ‡ͺ
  • The activist portal & your dashboard πŸ‡ΈπŸ‡ͺ
  • Participating in campaigns πŸ‡ΈπŸ‡ͺ
    • Finding the right action πŸ‡ΈπŸ‡ͺ
    • Three simple steps to participate πŸ‡ΈπŸ‡ͺ
    • If you need to cancel πŸ‡ΈπŸ‡ͺ
  • Phone banking with Zetkin Call πŸ‡ΈπŸ‡ͺ
    • Call assignments πŸ‡ΈπŸ‡ͺ
    • Before you start calling πŸ‡ΈπŸ‡ͺ
    • Making a call πŸ‡ΈπŸ‡ͺ
      • Prepare for the call πŸ‡ΈπŸ‡ͺ
      • Make the call πŸ‡ΈπŸ‡ͺ
      • Report the call πŸ‡ΈπŸ‡ͺ
    • Repeating a call πŸ‡ΈπŸ‡ͺ
  • Surveys πŸ‡ΈπŸ‡ͺ

For officials

  • Introduction πŸ‡ΈπŸ‡ͺ
  • Using Zetkin Organize πŸ‡ΈπŸ‡ͺ
    • The Organize sections πŸ‡ΈπŸ‡ͺ
    • Multi-tasking with panes πŸ‡ΈπŸ‡ͺ
    • Using search πŸ‡ΈπŸ‡ͺ
    • Managing officials πŸ‡ΈπŸ‡ͺ
  • Managing people πŸ‡ΈπŸ‡ͺ
    • Importing people πŸ‡ΈπŸ‡ͺ
    • Adding and editing people πŸ‡ΈπŸ‡ͺ
    • Keeping things organized with tags πŸ‡ΈπŸ‡ͺ
    • Smart search with person queries πŸ‡ΈπŸ‡ͺ
    • Sending invites πŸ‡ΈπŸ‡ͺ
  • Working with campaigns πŸ‡ΈπŸ‡ͺ
    • Campaign basics and terminology πŸ‡ΈπŸ‡ͺ
    • Campaign phases πŸ‡ΈπŸ‡ͺ
    • Campaign actions πŸ‡ΈπŸ‡ͺ
      • Creating and editing actions πŸ‡ΈπŸ‡ͺ
      • Handling sign-ups and bookings πŸ‡ΈπŸ‡ͺ
      • Moving participants πŸ‡ΈπŸ‡ͺ
      • Sending action reminders πŸ‡ΈπŸ‡ͺ
    • Analyzing campaign distribution and geography πŸ‡ΈπŸ‡ͺ
  • Working with phone banking πŸ‡ΈπŸ‡ͺ
    • Call assignment basics πŸ‡ΈπŸ‡ͺ
    • Creating a call assignment πŸ‡ΈπŸ‡ͺ
    • Managing callers πŸ‡ΈπŸ‡ͺ
    • The call log πŸ‡ΈπŸ‡ͺ
  • Surveys πŸ‡ΈπŸ‡ͺ
    • Creating and editing surveys πŸ‡ΈπŸ‡ͺ
    • Questions and text blocks πŸ‡ΈπŸ‡ͺ
    • Collecting submissions πŸ‡ΈπŸ‡ͺ
    • Following up survey responses πŸ‡ΈπŸ‡ͺ
  • Managing your region πŸ‡ΈπŸ‡ͺ
    • Managing locations πŸ‡ΈπŸ‡ͺ
  • Tips and tricks πŸ‡ΈπŸ‡ͺ
    • Using keyboard shortcuts πŸ‡ΈπŸ‡ͺ
    • Editing rich text πŸ‡ΈπŸ‡ͺ
    • Quick-edit with alt key πŸ‡ΈπŸ‡ͺ
    • Filtering lists with the filter drawer
    • Tricks while searching (e.g. searching for dates)
  • Tutorials πŸ‡ΈπŸ‡ͺ
    • Import your members πŸ‡ΈπŸ‡ͺ
    • Plan a campaign πŸ‡ΈπŸ‡ͺ
    • Mobilize a campaign using phone banking πŸ‡ΈπŸ‡ͺ
    • Manage a running campaign πŸ‡ΈπŸ‡ͺ

For developers

  • Introduction πŸ‡ΈπŸ‡ͺ
  • Contributing to the Zetkin project πŸ‡ΈπŸ‡ͺ
  • Customizing Zetkin applications πŸ‡ΈπŸ‡ͺ
  • Developing your own Zetkin applications πŸ‡ΈπŸ‡ͺ
  • The Zetkin Platform πŸ‡ΈπŸ‡ͺ
    • Fundamentals and architecture πŸ‡ΈπŸ‡ͺ
    • Using the Zetkin Platform API πŸ‡ΈπŸ‡ͺ
      • Registering your application πŸ‡ΈπŸ‡ͺ
      • Authentication πŸ‡ΈπŸ‡ͺ

Contributing

You can contribute to the manual in many ways.

Suggesting changes

If you want to suggest improvements, highlight language or fact errors, let us know about a technical bug that you've found, or in any other way suggest changes to the documents in the Zetkin Manual, please create an issue ticket in the issue tracker.

Translating to your language

If you want to translate the manual to your language, please create a fork and work on your translation there. Contact us for details on how translation works.

Fixing bugs

If you are tech-savvy and willing to help out with development of the Zetkin Manual, you are very welcome to fixing bugs and making other improvements. Please create a fork of this repository, make the changes you want, and create a pull request to be reviewed by a Zetkin Foundation official.

Build instructions

If you intend to develop the manual and need to run a local copy of the site, we recommend that you use Docker. The Zetkin Manual is developed using Jekyll, which depends on Ruby and several other pieces of software. To avoid having to install it all, use the official Jekyll Docker container.

If you are unfamiliar with Docker, other solutions will do as well. But we do recommend that you learn about Docker, which is used extensively throughout the Zetkin project.

Below are the commands necessary to get started. If you have created your own fork, you likely want to clone that instead of the official manual.zetkin.org repository from GitHub. Replace zetkin/ in the repository URL with your GitHub user name to clone your fork instead.

$ git clone git@github.com:zetkin/manual.zetkin.org
$ cd manual.zetkin.org
$ docker run --rm -ti -v $PWD:/srv/jekyll -p 4000:4000 jekyll/jekyll jekyll serve -i

The final command will start running the Jekyll Docker container and serving the Zetkin Manual on port 4000 of the host on which Docker is running (usually localhost or whatever is returned by docker-machine ip default). Browse to [http://localhost:4000] to se the manual running locally. Make any changes to the source files and the site will rebuild and start serving the updated version automatically.