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.