Logo
latest
Zulip homepage
  • Overview
    • Zulip overview
      • Getting started
    • Contributing to Zulip
      • Community
      • Ways to contribute
      • Your first (codebase) contribution
        • Picking an issue
        • Working on an issue
        • And beyond
      • What makes a great Zulip contributor?
      • Reporting issues
      • User feedback
      • Outreach programs
        • Google Summer of Code
      • Zulip outreach
    • Zulip architectural overview
      • Key codebases
      • Usage assumptions and concepts
      • Components
        • Django and Tornado
        • nginx
        • Supervisor
        • memcached
        • Redis
        • RabbitMQ
        • PostgreSQL
        • Nagios
      • Glossary
    • Directory structure
      • Core Python files
      • HTML templates
      • JavaScript, TypeScript, and other static assets
      • Tests
      • Management commands
      • Scripts
      • API and bots
      • Production Puppet configuration
      • Additional Django apps
      • Jinja2 compatibility files
      • Translation files
      • Documentation
    • Release lifecycle
      • Server and web app
        • Stable releases
        • Git versions
        • Compatibility and upgrading
        • Security releases
        • Upgrade nag
        • Operating system support
        • Server roadmap
      • Client apps
      • API bindings
    • Version history
      • Zulip 5.x series
        • 5.0 – unreleased
      • Zulip 4.x series
        • 4.5 – 2021-07-25
        • 4.4 – 2021-07-22
        • 4.3 – 2021-06-02
        • 4.2 – 2021-05-13
        • 4.1 – 2021-05-13
        • 4.0 – 2021-05-13
      • Zulip 3.x series
        • 3.4 – April 14, 2021
        • 3.3 – December 1, 2020
        • 3.2 – September 15, 2020
        • 3.1 – July 30, 2020
        • 3.0 – July 16, 2020
      • Zulip 2.1.x series
        • 2.1.7 – 2020-06-25
        • 2.1.6 – 2020-06-17
        • 2.1.5 – 2020-06-16
        • 2.1.4 – 2020-04-16
        • 2.1.3 – 2020-04-01
        • 2.1.2 – 2020-01-16
        • 2.1.1 – 2019-12-13
        • 2.1.0 – 2019-12-12
      • Zulip 2.0.x series
        • 2.0.8 – 2019-12-12
        • 2.0.7 – 2019-11-21
        • 2.0.6 – 2019-09-23
        • 2.0.5 – 2019-09-11
        • 2.0.4 – 2019-06-29
        • 2.0.3 – 2019-04-23
        • 2.0.2 – 2019-03-15
        • 2.0.1 – 2019-03-04
        • 2.0.0 – 2019-03-01
      • Zulip 1.9.x series
        • 1.9.2 – 2019-01-29
        • 1.9.1 – 2018-11-30
        • 1.9.0 – 2018-11-07
      • Zulip 1.8.x series
        • 1.8.1 – 2018-05-07
        • 1.8.0 – 2018-04-17
      • Zulip 1.7.x series
        • 1.7.2 – 2018-04-12
        • 1.7.1 – 2017-11-21
        • 1.7.0 – 2017-10-25
      • Zulip 1.6.x and older
        • 1.6.0 – 2017-06-06
        • 1.5.2 – 2017-06-01
        • 1.5.1 – 2017-02-07
        • 1.5.0 – 2017-02-06
        • 1.4.3 - 2017-01-29
        • 1.4.2 - 2016-09-27
        • 1.4.1 - 2016-09-03
        • 1.4.0 - 2016-08-25
        • 1.3.13 - 2016-06-21
        • 1.3.12 - 2016-05-10
        • 1.3.11 - 2016-05-02
        • 1.3.10 - 2016-01-21
        • 1.3.9 - 2015-11-16
        • 1.3.8 - 2015-11-15
        • 1.3.7 - 2015-10-19
      • Upgrade notes
  • Zulip in production
    • Requirements and scalability
      • Server
        • General
        • Operating system
        • Hardware specifications
        • Network and security specifications
      • Credentials needed
        • SSL certificate
        • Outgoing email
      • Scalability
    • Installing a production server
      • Step 1: Download the latest release
      • Step 2: Install Zulip
        • Installer options
      • Step 3: Create a Zulip organization, and log in
      • Step 4: Configure and use
      • Details: What the installer does
      • Troubleshooting
    • Troubleshooting and monitoring
      • Using supervisorctl
        • Checking status with supervisorctl status
        • Restarting services with supervisorctl restart all
        • Stopping services with supervisorctl stop all
      • Troubleshooting services
        • Restrict unattended upgrades
      • Monitoring
        • Nagios configuration
      • Memory leak mitigation
    • Management commands
      • Running management commands
        • Accessing an organization’s string_id
      • manage.py shell
      • Other useful manage.py commands
      • Custom management commands
    • Customize Zulip
      • Making changes
      • Specific settings
        • Domain and email settings
        • Authentication backends
        • Mobile and desktop apps
        • Terms of Service and Privacy policy
        • Miscellaneous server settings
      • Zulip announcement list
      • Enjoy your Zulip installation!
    • Mobile push notification service
      • How to sign up
      • Updating your server’s registration
      • Why this is necessary
      • Security and privacy
      • Submitting statistics
      • Rate limits
      • Sending push notifications directly from your server
    • Upgrade or modify Zulip
      • Upgrading to a release
      • Upgrading from a Git repository
      • Updating settings.py inline documentation
      • Troubleshooting and rollback
        • Rolling back to a prior version
      • Preserving local changes to service configuration files
        • nginx configuration changes
      • Upgrading the operating system
        • Upgrading from Ubuntu 18.04 Bionic to 20.04 Focal
        • Upgrading from Ubuntu 16.04 Xenial to 18.04 Bionic
        • Upgrading from Ubuntu 14.04 Trusty to 16.04 Xenial
        • Upgrading from Debian Stretch to Debian Buster
      • Upgrading PostgreSQL
      • Modifying Zulip
      • Making changes
        • Upgrading to future releases
        • Making changes with docker-zulip
      • Applying changes from master
        • Applying a small change
        • Upgrading to master
      • Contributing patches
    • Security model
      • Secure your Zulip server like your email server
      • Encryption and authentication
        • Passwords
      • Messages and history
      • Users and bots
      • User-uploaded content and user-generated requests
      • Final notes and security response
    • Authentication methods
      • Email and password
      • Plug-and-play SSO (Google, GitHub, GitLab)
      • LDAP (including Active Directory)
        • Synchronizing data
        • Multiple LDAP searches
        • Restricting access to an LDAP group
        • Restricting LDAP user access to specific organizations
        • Troubleshooting
      • SAML
        • IdP-initiated SSO
        • Restricting access to specific organizations
      • Apache-based SSO with REMOTE_USER
        • Setup instructions for Apache-based SSO
        • Troubleshooting Apache-based SSO
        • Life of an Apache-based SSO login attempt
      • Sign in with Apple
      • OpenID Connect
      • Adding more authentication backends
      • Development only
    • Backups, export and import
      • Backups
        • Restoring backups
        • What is included
        • Restore from manual backups
      • PostgreSQL streaming replication
      • Data export
        • Preventing changes during the export
        • Export your Zulip data
      • Import into a new Zulip server
        • Import options
        • Logging in
        • Deleting and re-importing
    • PostgreSQL database details
      • Remote PostgreSQL database
      • Debugging PostgreSQL database issues
      • Stopping the Zulip PostgreSQL database
      • Debugging issues starting PostgreSQL
      • PostgreSQL vacuuming alerts
    • File upload backends
      • S3 backend configuration
      • S3 bucket policy
      • Migrating from local uploads to Amazon S3 backend
    • Installing SSL certificates
      • Manual install
        • Testing
      • Certbot (recommended)
        • At initial Zulip install
        • After Zulip is already installed
        • How it works
      • Self-signed certificate
      • Troubleshooting
        • The Android app can’t connect to the server
        • The iOS app can’t connect to the server
        • The Android app connects to the server on some devices but not others
    • Outgoing email
      • How to configure
      • Email services
        • Free outgoing email services
        • Using system email
        • Using Gmail for outgoing email
        • Logging outgoing email to a file for prototyping
      • Troubleshooting
        • Advanced troubleshooting
    • Deployment options
      • Installing Zulip from Git
      • Zulip in Docker
      • Advanced installer options
      • Installing on an existing server
      • Running Zulip’s service dependencies on different machines
        • Using Zulip with Amazon RDS as the database
      • Using an alternate port
      • Using an outgoing HTTP proxy
      • Putting the Zulip application behind a reverse proxy
        • Installer options
        • nginx configuration
        • Apache2 configuration
        • HAProxy configuration
        • Other proxies
      • System and deployment configuration
        • [machine]
        • [deployment]
        • [application_server]
        • [certbot]
        • [postfix]
        • [postgresql]
        • [rabbitmq]
        • [memcached]
        • [loadbalancer]
        • [http_proxy]
    • Incoming email integration
      • Local delivery setup
      • Polling setup
    • Video call providers
      • Zoom
      • BigBlueButton
    • GIPHY GIF integration
      • Apply for API key
  • Development environment
    • Development environment installation
      • Requirements
      • Recommended setup (Vagrant)
      • Advanced setup
      • Slow internet connections
      • Installing remotely
      • Next steps
    • Recommended setup (Vagrant)
      • Requirements
      • Step 0: Set up Git & GitHub
      • Step 1: Install prerequisites
        • macOS
        • Ubuntu
        • Debian
        • Windows 10
        • Running Git BASH as an administrator
      • Step 2: Get Zulip code
      • Step 3: Start the development environment
      • Step 4: Developing
        • Where to edit files
        • Understanding run-dev.py debugging output
        • Committing and pushing changes with Git
        • Maintaining the development environment
        • Rebuilding the development environment
        • Shutting down the development environment for use later
        • Resuming the development environment
      • Next steps
      • Troubleshooting and common errors
        • Vagrant guest doesn’t show (zulip-py3-venv) at start of prompt
        • Vagrant was unable to mount VirtualBox shared folders
        • ssl read error
        • Unmet dependencies error
        • ssh connection closed by remote host
        • os.symlink error
        • Hyper-V error messages
        • Connection timeout on vagrant up
        • Vagrant was unable to communicate with the guest machine
        • Vagrant up fails with subprocess.CalledProcessError
        • VBoxManage errors related to VT-x or WHvSetupPartition
        • OSError: [Errno 26] Text file busy
      • Specifying an Ubuntu mirror
      • Specifying a proxy
      • Using a different port for Vagrant
      • Customizing CPU and RAM allocation
    • Advanced setup (non-Vagrant)
      • Installing directly on Ubuntu, Debian, CentOS, or Fedora
      • Installing directly on Windows 10 with WSL 2
      • Using the Vagrant Hyper-V provider on Windows (beta)
        • Problems you may encounter
      • Newer versions of supported platforms
      • Installing on Cloud9
        • Install zulip-cloud9
    • Using the development environment
      • Common
      • Server
      • Web
      • Mobile
    • Developing remotely
      • Connecting to the remote environment
      • Setting up user accounts
      • Setting up the development environment
      • Running the development server
      • Making changes to code on your remote development server
        • Editing locally
        • Editing remotely
        • Next steps
      • Using an nginx reverse proxy
    • Authentication in the development environment
      • Email and password
      • Google
      • GitHub
      • GitLab
      • Apple
      • SAML
      • When SSL is required
      • Testing LDAP in development
        • Testing avatar and custom profile field synchronization
        • Automated testing
      • Two factor authentication
      • Password form implementation
    • Testing the installer
      • Configuring
      • Running a test install
        • Build and unpack a release tarball
        • Test an install
        • See running containers after installation
        • Connect to a running container
        • Stopping and destroying containers
        • Iterating on the installer
  • Developer tutorials
    • Writing a new application feature
      • General process
        • Files impacted
        • Adding a field to the database
        • Backend changes
        • Frontend changes
        • Documentation changes
      • Example feature
        • Update the model
        • Create the migration
        • Test your migration changes
        • Handle database interactions
        • Update application state
        • Add a new view
        • Backend tests
        • Update the frontend
        • Frontend tests
        • Update documentation
    • Writing views in Zulip
      • What this covers
      • What is a view?
      • Modifying urls.py
      • Writing human-readable views
        • Decorators used for webpage views
        • Writing a template
      • Writing API REST endpoints
        • Request variables
        • Deciding which HTTP verb to use
        • Idempotency
        • Making changes to the database
        • Calling from the web application
        • Calling from an API client
      • Legacy endpoints used by the web client
      • Incoming webhook integrations
    • Life of a request
      • A request is sent to the server, and handled by Nginx
      • Static files are served directly by Nginx
      • Nginx routes other requests between Django and Tornado
      • Django routes the request to a view in urls.py files
      • Views serving HTML are internationalized by server path
      • API endpoints use REST
        • PUT is only for creating new things
        • OPTIONS
        • Legacy endpoints are used by the web client
        • Incoming webhook integrations may not be RESTful
      • Django calls rest_dispatch for REST endpoints, and authenticates
      • The view will authorize the user, extract request variables, and validate them
      • Results are given as JSON
    • Reading list
      • General programming/IT
      • Python
      • Java/Android
      • JavaScript/ECMAScript
      • TypeScript
      • Git/version control systems (VCS)
      • Computer science/algorithms
      • Community experience
      • Competitions/camps
      • Massive open online courses (MOOC) platforms
    • Screenshot and GIF software
      • Screenshot tools by platform
        • Browser
        • macOS
        • Windows
        • Linux
      • GIF tools by platform
        • Browser
        • macOS
        • Windows
        • Linux
    • Shell tips
      • The prompt ($)
      • Tilde character (~)
      • Change directory (cd)
      • Running commands as root (sudo)
      • Escaping characters
      • Sequencing commands
      • Splitting commands into multiple lines
      • Arguments
      • Shebang
      • Understanding commands
      • Cheatsheet
      • Git
  • Git guide
    • Quick start
    • Set up Git
      • Install and configure Git, join GitHub
      • Get a graphical client
    • Zulip-specific tools
      • Set up Git repo script
      • Configure continuous integration for your Zulip fork
      • Reset to pull request
      • Fetch a pull request and rebase
      • Fetch a pull request without rebasing
      • Push to a pull request
      • Delete unimportant branches
      • Merge conflict on yarn.lock file
    • How Git is different
    • Important Git terms
      • branch
      • cache
      • checkout
      • commit
      • fast-forward
      • fetch
      • hash
      • head
      • HEAD
      • index
      • pull
      • push
      • rebase
    • Get Zulip code
      • Step 1a: Create your fork
      • Step 1b: Clone to your machine
      • Step 1c: Connect your fork to Zulip upstream
      • Step 2: Set up the Zulip development environment
      • Step 3: Configure continuous integration for your fork
    • Working copies
      • Workflows
      • Relevant Git commands
    • Using Git as you work
      • Know what branch you’re working on
      • Keep your fork up to date
      • Work on a feature branch
      • Run linters and tests locally
      • Stage changes
        • Get status of working directory
        • Stage additions with git add
        • Stage deletions with git rm
      • Commit changes
      • Push your commits to GitHub
      • Examine and tidy your commit history
      • Force-push changes to GitHub after you’ve altered your history
    • Pull requests
      • Work in progress pull requests
      • Create a pull request
        • Step 0: Make sure you’re on a feature branch (not master)
        • Step 1: Update your branch with git rebase
        • Step 2: Push your updated branch to your remote fork
        • Step 3: Open the pull request
      • Update a pull request
    • Collaborate
      • Fetch another contributor’s branch
      • Check out a pull request locally
    • Fixing commits
      • Fixing the last commit
        • Changing the last commit message
        • Changing the last commit
      • Fixing older commits
        • Changing commit messages
        • Deleting old commits
      • Squashing commits
      • Reordering commits
      • Pushing commits after tidying them
    • Reviewing changes
      • Changes on (local) working tree
      • Changes within branches
      • Changes between branches
    • Get and stay out of trouble
      • Undo a merge commit
      • Restore a lost commit
      • Recover from a git rebase failure
      • Working from multiple computers
    • Git cheat sheet
      • Common commands
      • Detailed cheat sheet
  • Code contribution guide
    • Version control
      • Commit discipline
      • Commit messages
        • Good summaries:
        • Message body:
    • Code style and conventions
      • Be consistent!
      • Lint tools
      • Secrets
      • Dangerous constructs
        • Too many database queries
        • UserProfile.objects.get() / Client.objects.get() / etc.
        • Using Django model objects as keys in sets/dicts
        • user_profile.save()
        • Using raw saves to update important model objects
        • Naive datetime objects
        • x.attr('zid') vs. rows.id(x)
        • JavaScript const and let
        • JavaScript and TypeScript for (i in myArray)
        • Translation tags
        • Paths to state or log files
      • JS array/object manipulation
      • More arbitrary style things
        • Line length
        • JavaScript and TypeScript
        • HTML / CSS
        • Python
        • Tests
        • Third party code
    • Reviewing Zulip code
      • Protocol for authors
        • Responding to a review feedback
      • Principles of code review
        • Anyone can review
        • Please do reviews
        • Fast replies are key
      • Things to look for
        • Zulip server
      • Tooling
      • Additional resources
    • Using zulipbot
      • Usage
        • Contributing
    • Accessibility
      • Guidelines
      • Tools
      • GitHub issues
      • Additional resources
    • Bug report guidelines
    • Zulip Code of Conduct
      • Expected behavior
      • Unacceptable behavior
      • Reporting and enforcement
      • Scope
      • License and attribution
    • Google Summer of Code
      • About us
        • Our history with Google Open Source Programs
        • Expectations for GSoC students
      • Getting started
      • Application tips, and how to be a strong candidate
      • Mentors
      • Project ideas
        • Focus areas
        • Full stack and web frontend focused projects
        • React Native mobile app
        • Electron desktop app
        • Terminal app
        • Archive tool
      • Circulating proposals (March to April)
    • How to have an amazing summer with Zulip
      • What makes a successful summer
      • Extra notes for mentors
  • Code testing
    • Testing overview
      • Running tests
      • Major test suites
      • Other test suites
      • Internet access inside test suites
        • Documentation tests
    • Linters
      • Overview
      • Running the linters
      • General considerations
      • Lint checks
      • lint
        • Special options
        • Lint checks
      • Philosophy
        • Speed
        • Accuracy
        • Completeness
    • Backend Django tests
      • Overview
      • Running tests
      • Writing tests
        • Setting up data for tests
        • Testing code that accesses the filesystem
        • Testing with mocks
      • Zulip testing philosophy
        • Endpoint tests
        • Library tests
        • Fixture-driven tests
        • Mocks and stubs
        • Template tests
        • SQL performance tests
        • Event-based tests
        • Negative tests
      • Testing considerations
    • JavaScript/TypeScript unit tests
      • How the node tests work
      • Handling dependencies in unit tests
      • Creating new test modules
      • Coverage reports
      • Editor debugger integration
      • Webstorm integration setup
      • Running tests with the debugger
    • Web frontend black-box Puppeteer tests
      • Running tests
      • How Puppeteer tests work
      • Debugging Puppeteer tests
      • Writing Puppeteer tests
    • Python static type checker (mypy)
      • Installing mypy
      • Running mypy on Zulip’s code locally
      • Mypy is there to find bugs in Zulip before they impact users
      • Mypy stubs for third-party modules
      • type_debug.py
      • Using @overload to accurately describe variations
      • Best practices
        • When is a type annotation justified?
        • Avoid the Any type
        • Avoid cast()
        • Avoid # type: ignore comments
        • Avoid other unchecked constructs
        • Use Optional and None correctly
        • Read-only types
        • Typing decorators
      • Troubleshooting advice
    • TypeScript static types
      • Type checking
      • Linting and style
      • Migration strategy
    • Continuous integration (CI)
      • Goals
      • GitHub Actions
        • Useful debugging tips and tools
        • Suites
        • Configuration
        • Images
        • Performance optimizations
    • Manual testing
      • Basic stuff
        • Message view
        • Messagebox
        • Message editing
        • Narrowing
        • Composing messages
        • Popover menus
        • Sidebar filtering
        • Stream permissions
        • Search
        • Stream settings
        • User settings
        • Keyboard shortcuts
        • Miscellaneous menu options
        • Inviting users/tutorial
        • To be continued…
    • Testing philosophy
      • Effective testing allows us to move quickly
      • Test suite performance and reliability are critical
      • Integration testing or unit testing?
      • Avoid duplicating code with security impact
      • Share test setup code
      • What isn’t tested probably doesn’t work
  • Subsystems documentation
    • Provisioning and third-party dependencies
      • Provisioning
        • PROVISION_VERSION
      • Philosophy on adding third-party dependencies
      • System packages
      • Python packages
        • Upgrading packages
      • JavaScript and other frontend packages
      • Node and Yarn
      • ShellCheck and shfmt
      • Puppet packages
      • Other third-party and generated files
        • Emoji
        • Translations data
        • Pygments data
      • Modifying provisioning
    • Settings system
      • Server settings
        • Testing non-default settings
      • Realm settings
    • HTML and CSS
      • Zulip CSS organization
      • Editing Zulip CSS
      • CSS style guidelines
        • Avoid duplicated code
        • Be consistent with existing similar UI
        • Use clear, unique names for classes and object IDs
      • Validating CSS
      • HTML templates
        • Behavior
        • Backend templates
        • Frontend templates
        • Toolchain
        • Translation
        • Tooltips
      • Static asset pipeline
        • Primary build process
        • Adding static files
        • How it works in production
        • ES6/TypeScript modules
    • Real-time push and events
      • Generation system
      • Delivery system
      • The initial data fetch
        • Testing
        • Messages
      • Schema changes
    • Sending messages
      • Message lists
      • Compose area
      • Backend implementation
      • Local echo
        • Local echo in message editing
      • Putting it all together
      • Message editing
        • Inline URL previews
      • Soft deactivation
    • Notifications in Zulip
      • Important corner cases
      • The mobile/email notifications flow
    • Queue processors
      • Adding a new queue processor
      • Publishing events into a queue
      • Clearing a RabbitMQ queue
    • Unread counts and the pointer
      • Pointer logic
        • Recipient bar: message you clicked
        • Search, sidebar click, or new tab: unread/recent matching narrow
        • Unnarrow: previous sequence
        • Forced reload: state preservation
      • Unread count logic
      • Testing and development
    • Markdown implementation
      • Testing
      • Changing Zulip’s Markdown processor
      • Per-realm features
      • Zulip’s Markdown philosophy
      • Zulip’s changes to Markdown
        • Basic syntax
        • Lists
        • Links
        • Code
        • Other
    • Caching in Zulip
      • Backend caching with memcached
        • The core implementation
        • Cautions
        • Cache invalidation after writes
        • Production deployments and database migrations
        • Automated testing and memcached
        • Manual testing and memcached
        • Performance
      • In-process caching in Django
      • Browser caching of state
    • Performance and scalability
      • Load profiles
      • Major Zulip endpoints
        • Tornado
        • Presence
        • Fetching page_params
        • Fetching message history
        • User uploads
        • Sending and editing messages
        • Other endpoints
      • Queue processors and cron jobs
      • Service scalability
    • Realms in Zulip
      • Creating realms
        • Using unique link generator
        • Enabling open realm creation
      • Subdomains
        • Working with subdomains in development environment
    • Management commands
      • Writing management commands
    • Schema migrations
      • Automated testing for migrations
      • Schema and initial data changes
    • URL hashes and deep linking
      • Hashchange
      • Server-initiated reloads
      • All reloads
    • Emoji
      • Emoji codes
        • Custom emoji
      • Tooling
      • Picking emoji names
    • Hotspots
      • Adding a new hotspot
        • Step 1: Create hotspot content
        • Step 2: Configure hotspot placement
        • Step 3: Test manually
        • Step 4 (if necessary): Tweak hotspot icon z-index
    • Full-text search
      • The default full-text search implementation
      • Multi-language full-text search
        • Enabling PGroonga
        • Disabling PGroonga
    • Email
      • Development and testing
        • Testing in a real email client
        • Notes
      • Email templates
    • Analytics
      • Analytics backend overview
      • The *Count database tables
      • CountStats
      • The FillState table
      • Performance strategy
      • Backend testing
      • LoggingCountStats
      • Analytics UI development and testing
        • Setup and testing
        • Adding or editing /stats graphs
        • /activity page
    • Clients in Zulip
      • Analytics
      • Integrations
    • Logging and error reporting
      • Backend error reporting
        • Backend logging
      • Blueslip frontend error reporting
      • Frontend performance reporting
    • Typing indicators
      • Writing user
      • Server
      • Receiving user
      • Ecosystem
      • Roadmap
    • Upgrading Django
    • Zulip server release checklist
      • A week before the release
      • Final release preparation
      • Executing the release
      • Post-release
    • Zulip PyPI package release checklist
    • UI: input pills
      • Setup
      • Basic usage
      • Typeahead
        • onPillCreate and onPillRemove methods
    • Presence
    • Unread message synchronization
    • Billing
      • Upgrading Stripe API versions
    • Widgets
      • What is a widget?
      • /me messages
      • Polls, todo lists, and games
        • Data flow
        • Backward compatibility
        • Adding widgets
      • zform (trivia quiz bot)
      • Data flow
    • Slash commands
      • Data flow
      • Typeahead
  • Writing documentation
    • Documentation systems
      • Developer and sysadmin documentation
      • Core website documentation
      • User facing documentation
        • General user documentation
        • Integrations documentation
        • API documentation
      • Automated testing
    • User documentation
      • Editing and testing
      • Writing documentation
        • User interface
        • Voice
      • Features
        • Images
        • Icons
        • Macros
        • Tips and warnings
        • Tab switcher
    • Documenting an integration
      • Markdown macros
      • Writing guidelines
        • General writing guidelines
        • Guidelines for specific steps
        • Screenshots
    • Documenting REST API endpoints
      • How it works
        • Title and description
        • Usage examples
        • Parameters
        • Displaying example payloads/responses
      • Step by step guide
      • Why a custom system?
    • OpenAPI configuration
      • Working with the zulip.yaml file
        • Configuration
        • Endpoint definitions
        • Schemas
      • Zulip Swagger YAML style:
      • Tips for working with YAML:
        • Formatting help:
        • Examples:
  • Translating Zulip
    • Translation guidelines
      • Translators’ workflow
        • Testing translations
        • Translation style guides
        • Capitalization
    • Internationalization for developers
      • Key details about human language
      • Translation process
      • Translation resource files
      • HTML Templates
      • Backend translations
        • Jinja2 templates
        • Python
      • Frontend translations
        • Handlebars templates
      • Transifex config
      • Transifex CLI setup
    • Chinese translation style guide(中文翻译指南)
      • Note(题记)
      • Terms(术语)
      • Phrases(习惯用语)
      • Others(其它)
    • French translation style guide
      • Rules
      • Terms
    • German translation style guide (Richtlinien für die deutsche Übersetzung)
      • Rules
        • Formal or informal?
        • Form of address
        • Form of instruction
        • Rules for labels
        • Concatenation of words
        • Anglicisms
        • Special characters
        • False friends
        • Other
      • Terms (Begriffe)
      • Phrases (Ausdrücke)
      • Other (Verschiedenes)
    • Hindi translation style guide(हिन्दी अनुवाद शैली मार्गदर्शक)
      • Terms(शर्तें)
      • Phrases (वाक्यांशों)
      • Others(अन्य)
    • Polish translation style guide
      • Special terms used in Zulip
    • Russian translation style guide
      • Перевод некоторых терминов
    • Spanish translation style guide
      • Términos
      • Frases
      • Otros
  • Index
Zulip
  • »
  • Writing documentation
  • Edit on GitHub

Writing documentation¶

  • Documentation systems
    • Developer and sysadmin documentation
    • Core website documentation
    • User facing documentation
      • General user documentation
      • Integrations documentation
      • API documentation
    • Automated testing
  • User documentation
    • Editing and testing
    • Writing documentation
      • User interface
      • Voice
    • Features
      • Images
      • Icons
      • Macros
      • Tips and warnings
      • Tab switcher
  • Documenting an integration
    • Markdown macros
    • Writing guidelines
      • General writing guidelines
      • Guidelines for specific steps
      • Screenshots
  • Documenting REST API endpoints
    • How it works
      • Title and description
      • Usage examples
      • Parameters
      • Displaying example payloads/responses
    • Step by step guide
    • Why a custom system?
  • OpenAPI configuration
    • Working with the zulip.yaml file
      • Configuration
      • Endpoint definitions
      • Schemas
    • Zulip Swagger YAML style:
    • Tips for working with YAML:
      • Formatting help:
      • Examples:
Next Previous

© Copyright 2012–2015 Dropbox, Inc., 2015–2021 Kandra Labs, Inc., and contributors. Revision f84703bc.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
4.5
4.4
4.3
4.2
4.1
4.0
3.4
3.3
3.2
3.1
3.0
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.9.2
1.9.1
1.9.0
Downloads
html
On Read the Docs
Project Home
Builds