Skip to content

Support

Garot Conklin edited this page Feb 6, 2025 · 3 revisions

Support

Welcome to the DataDog Dashboard Deployer support page. This document outlines the various ways to get help, report issues, and engage with the community.

Getting Help

1. Documentation

2. Community Support

GitHub Discussions

Our primary platform for community support is GitHub Discussions. Here you can:

  • Ask questions
  • Share ideas
  • Show off your dashboards
  • Engage with other users
  • Get help with configuration

Issue Tracker

Use our GitHub Issues for:

  • Bug reports
  • Feature requests
  • Documentation improvements
  • Performance issues

How to Get Help

1. Before Asking

  1. Check the Documentation

    • Review relevant documentation sections
    • Search the wiki
    • Check the FAQ
  2. Search Existing Resources

    • Search GitHub Issues
    • Search GitHub Discussions
    • Check closed issues
  3. Gather Information

    • Python version
    • Package version
    • Error messages
    • Configuration files
    • Relevant logs

2. Asking for Help

When creating a new issue or discussion, please include:

  1. Problem Description

    ## Problem
    
    Clearly describe what you're trying to achieve and what's not working.
    
    ## Expected Behavior
    
    What you expected to happen.
    
    ## Actual Behavior
    
    What actually happened.
  2. Environment Information

    ## Environment
    
    - OS: [e.g., Ubuntu 20.04]
    - Python Version: [e.g., 3.8.5]
    - Package Version: [e.g., 1.0.0]
  3. Reproduction Steps

    ## Steps to Reproduce
    
    1. Step one
    2. Step two
    3. Step three
  4. Code Examples

    ## Configuration
    
    ```yaml
    dashboards:
      - name: "Example"
        ...
    ```

    Error Message

    Full error message here
    

Contributing

1. Code Contributions

  • Fork the repository
  • Create a feature branch
  • Make your changes
  • Submit a pull request

2. Documentation

  • Help improve the wiki
  • Fix typos
  • Add examples
  • Clarify instructions

3. Testing

  • Report bugs
  • Add test cases
  • Verify fixes
  • Test new features

Community Guidelines

1. Code of Conduct

We follow a Code of Conduct that establishes:

  • Expected behavior
  • Unacceptable behavior
  • Enforcement
  • Reporting guidelines

2. Communication

  • Be respectful
  • Stay on topic
  • Help others
  • Share knowledge

3. Best Practices

  • Use clear titles
  • Provide context
  • Format code properly
  • Follow templates

Support Channels

1. Primary Channels

  • GitHub Issues
  • GitHub Discussions
  • Pull Requests
  • Wiki Pages

2. Additional Resources

  • Stack Overflow: Tag datadog-dashboard-deployer
  • DataDog Community Forums
  • Python Community Resources

Enterprise Support

For enterprise users, we offer:

  1. Priority Support

    • Dedicated response times
    • Direct communication
    • Priority bug fixes
  2. Custom Development

    • Feature development
    • Integration support
    • Performance optimization
  3. Training

    • Team workshops
    • Best practices
    • Implementation guidance

Contact us at support@flexrpl.com for enterprise support inquiries.

Feedback

We value your feedback! Help us improve by:

  1. Participating in Discussions

    • Share your use cases
    • Suggest improvements
    • Report success stories
  2. Contributing to Development

    • Code contributions
    • Documentation updates
    • Bug reports
  3. Spreading the Word

    • Star the repository
    • Share with others
    • Write about your experience

Clone this wiki locally