Skip to content

KSML Community and Support

Welcome to the KSML community! This guide provides information on how to get help, connect with other KSML users, and contribute to the project.

Getting Help

Documentation

The first place to look for answers is the KSML documentation:

Community Forums

Join our community forums to ask questions, share your experiences, and connect with other KSML users:

Issue Tracker

If you believe you've found a bug or want to request a feature:

  1. Check the existing issues to see if it's already reported
  2. If not, create a new issue with:
  3. A clear, descriptive title
  4. A detailed description of the problem or feature request
  5. Steps to reproduce (for bugs)
  6. Expected vs. actual behavior (for bugs)
  7. KSML version and environment details

Commercial Support

For enterprise users requiring dedicated support, Axual offers commercial support packages. Contact support@axual.com for more information.

Community Resources

Community Calls

Join our monthly community calls to: - Learn about new features and roadmap - See demos and use cases - Ask questions directly to the KSML team - Connect with other users

Check the community calendar for upcoming calls.

Slack Channel

Join our Slack workspace for real-time discussions: - #ksml-general - General discussions about KSML - #ksml-help - Get help with specific issues - #ksml-announcements - Stay updated on new releases and events

Newsletter

Subscribe to our newsletter to receive: - Release announcements - Tutorial spotlights - Community highlights - Upcoming events

Contributing to KSML

We welcome contributions from the community! Here's how you can contribute:

Code Contributions

  1. Fork the KSML repository
  2. Create a branch for your changes
  3. Make your changes following our coding standards
  4. Write tests for your changes
  5. Submit a pull request

Before starting work on a significant contribution, please open an issue to discuss it with the maintainers.

Documentation Contributions

Help improve the KSML documentation:

  1. Fork the repository
  2. Make your documentation changes
  3. Submit a pull request

We especially appreciate: - Clarifications to existing documentation - New examples and tutorials - Fixes for typos and broken links

Example Contributions

Share your KSML examples with the community:

  1. Create a well-documented example
  2. Ensure it follows best practices
  3. Submit it to the examples directory

Reporting Issues

Quality bug reports help us improve KSML. When reporting issues:

  1. Include a clear description of the problem
  2. Provide steps to reproduce
  3. Include relevant logs and error messages
  4. Share your KSML definition file (with sensitive information removed)
  5. Mention your environment (KSML version, OS, etc.)

Community Guidelines

To ensure a positive community experience for everyone, please follow these guidelines:

Code of Conduct

All community members are expected to adhere to our Code of Conduct, which promotes:

  • Respectful and inclusive communication
  • Constructive feedback
  • Collaborative problem-solving
  • A welcoming environment for everyone

Communication Tips

  • Be specific: When asking questions, provide context and details
  • Share knowledge: Answer questions when you can help others
  • Be patient: Remember that community members are volunteers
  • Use appropriate channels: Post questions in the right forum or channel
  • Search first: Check if your question has already been answered

Staying Updated

Release Information

Social Media

Follow us on social media for updates, tips, and community highlights:

Events and Meetups

Conferences

Look for KSML presentations at these conferences: - Kafka Summit - Strata Data Conference - Data + AI Summit

Meetups

Find local KSML and Kafka Streams meetups: - Meetup.com - Eventbrite

Webinars and Workshops

Register for upcoming webinars and workshops: - Axual Events Page - KSML YouTube Channel

Success Stories

We love hearing how you're using KSML! Share your success stories:

  1. Write a blog post about your experience
  2. Submit a case study to community@axual.com
  3. Present at a community call or meetup

Featured success stories: - How Company X Reduced Development Time by 50% with KSML - Building Real-time Analytics at Scale with KSML

Frequently Asked Questions

General Questions

Q: Is KSML open source?
A: Yes, KSML is open source under the Apache 2.0 license.

Q: How does KSML compare to writing Kafka Streams applications in Java?
A: KSML provides a higher-level abstraction that makes it easier to define stream processing applications without writing Java code. It's particularly beneficial for data engineers and analysts who may not be Java experts.

Q: Can I use KSML in production?
A: Yes, KSML is production-ready and used by many organizations in production environments.

Technical Questions

Q: Can I extend KSML with custom operations?
A: Yes, you can create custom operations in Java and use them in your KSML definitions.

Q: How does KSML handle schema evolution?
A: KSML supports schema evolution through its integration with schema registries and flexible data handling.

Q: What's the performance impact of using KSML vs. native Kafka Streams?
A: KSML compiles down to native Kafka Streams code, so the runtime performance is comparable to hand-written Kafka Streams applications.

Conclusion

The KSML community is here to help you succeed with your stream processing projects. Whether you're just getting started or you're an experienced user, we encourage you to participate, ask questions, and share your knowledge.

Remember that every community member was once a beginner. By helping others and contributing back, you help make KSML better for everyone.

We look forward to seeing what you build with KSML!