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
  • Other third-party and generated files
    • Emoji
    • Translations data
    • Pygments data
    • Authors data
  • Modifying provisioning
• Settings system
  • Server settings
    • Testing non-default settings
  • Realm settings
• Real-time Push and Events
  • Generation system
  • Delivery system
  • The initial data fetch
    • Testing
    • Messages
• Sending messages
  • Message lists
  • Compose area
  • Backend implementation
    • Websockets
  • Local echo
  • Putting it all together
  • Error handling
  • Message editing
    • Inline URL previews
  • Soft deactivation
• Queue processors
  • Adding a new queue processor
  • Publishing events into a queue
  • Clearing a RabbitMQ queue
• Custom Apps
  • Definition
  • Problem statement
  • A quick note on bots/integrations
  • Categories of custom apps
    • Stimulus/response and read/write
    • World Reader/Zulip Reader
    • Other classifications
  • World Reader
    • Zulip integrations
  • Zulip Reader
  • Deployment issues
    • Local deployment
    • Non-Zulip dedicated hardware
    • Zulip-side support for reader apps
• Unread counts and the pointer
  • Pointer logic
    • Recipient bar: message you clicked
    • Search, sidebar click, or new narrowed tab: unread/recent matching narrow
    • Unnarrow: previous sequence
    • New All messages view: “high watermark”
    • 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
    • Performance
  • In-process caching in Django
  • Browser caching of state
• 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
• Static asset pipeline
  • Primary build process
  • Adding static files
  • How it works in production
  • Webpack/CommonJS/ES6/Typescript modules
    • Hot Reloading
• Schema Migrations
  • Automated testing for migrations
• Renumbering Migrations
• 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
• 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
  • An optional full-text search implementation
    • How to enable full-text search across all languages
    • How to disable full-text search across all languages
• Authentication in the development environment
  • Testing OAuth in development
    • Google
    • GitHub
    • When SSL is required
  • Testing LDAP in development
• Email
  • Development and testing
  • 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
• HTML templates
  • Behavior
  • Backend
  • Frontend
    • Toolchain
    • Translation
• 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
• Users data model
• Upgrading Django
• Zulip server release checklist
  • A week before the release
  • Final release preparation
  • Executing the release
  • Post-release
• Zulip PyPI package release checklist
• OpenAPI REST API documentation
  • Working with the zulip.yaml file
    • Configuration
    • Endpoint definitions
    • Schemas
  • Zulip Swagger YAML style:
  • Tips for working with YAML:
    • Formatting help:
    • Examples:
• Exporting data from a large multi-realm Zulip server
  • Draft status
  • Overview
  • Exporting multiple realms’ data when moving to a new server
    • Public Realm Data
    • Cross Realm Data
    • Disjoint User Data
    • Recipient Data
    • File-related Data
    • Message Data
    • Summary
  • Risk Mitigation
    • Generic considerations
    • Approved Transfers
    • Risk factors broken out by data categories
• UI: Input Pills
  • Setup
  • Basic Usage
  • Typeahead
    • onPillCreate and onPillRemove methods
• Thumbnailing
  • URL design
  • Avatars, realm icons, and custom emoji
• Presence
• Unread message synchronization
• Billing
  • Upgrading Stripe API versions
• 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
  • Features
    • Images
    • Icons
    • Macros
    • Tips and warnings
• Documenting an integration
  • Markdown macros
  • Writing guidelines
    • General writing guidelines
    • Guidelines for specific steps
    • Screenshots
• Widgets (experimental)
  • Overview
  • Simple slash commands
    • Data flow
    • Availability
  • Poll, todo lists, and games
    • Data flow
    • Backward compatibility
    • Adding widgets
  • zform (Trivia Quiz bot)
  • Data flow
  • Slash commands