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.
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.
- Introduction πΈπͺ
- The user account πΈπͺ
- Forgot password πΈπͺ
- Managing your account πΈπͺ
- Deleting account πΈπͺ
- The organization membership πΈπͺ
- Connecting to an organization πΈπͺ
- Accepting an invite πΈπͺ
- 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 πΈπͺ
- 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 πΈπͺ
- 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 πΈπͺ
You can contribute to the manual in many ways.
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.
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.
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.
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.