diff --git a/SECURITY.md b/SECURITY.md index 8910e9fd..2739a9e3 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,8 +6,8 @@ LizardByte only supports the latest version of our software. ## Reporting a Vulnerability -If you think you have found a security vulnerability in our software, please report it to us using the "Security" tab -on the GitHub repository. +If you think you have found a security vulnerability in our software, please report it to us privately using the +"Security" tab on the GitHub repository. After you have submitted the vulnerability, we will review the report internally and respond to you with any questions or next steps. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..def71172 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,35 @@ +# Support + +> [!WARNING] +> We use GitHub issues exclusively for actionable bug reports. Low-effort issues will be immediately closed. +> Spamming the GitHub repo or organization will result in a ban. + +## Getting Support + +**First, read the documentation!** Many common questions are answered in our comprehensive docs. + +| Platform | Support Type | Description | +|----------------------------------------------------------------------------|-----------------------|----------------------------------------| +| πŸ“– [Read the Docs](https://docs.lizardbyte.dev/latest/about/overview.html) | **Documentation** | Official documentation and guides | +| πŸ’¬ [Discord](https://discord.com/invite/d6MpcrbYQs) | **Primary Support** | Real-time chat support | +| πŸ™ [GitHub Discussions](https://github.com/orgs/LizardByte/discussions) | **Primary Support** | Feature requests and general discourse | +| πŸ‘½ [Reddit](https://www.reddit.com/r/LizardByte) | **Community Support** | Community-driven support | + +## Additional Resources + +- 🏠 [Homepage](https://app.lizardbyte.dev/) +- πŸ”§ [Status Page](https://status.LizardByte.dev) +- πŸ“ [Blog](https://app.lizardbyte.dev/blog) +- πŸ—ΊοΈ [Roadmap](https://app.lizardbyte.dev/roadmap) + +## Support Guidelines + +When seeking support, please: + +1. **Read the documentation first** - Many common questions are already answered in docs +2. **Use the appropriate channel** - Each platform has multiple channels/categories for support, + select the one that best fits your question +3. **Be courteous and respectful** - Follow community guidelines and be patient with volunteers +4. **Provide detailed information** - Include logs, error messages, and system information when relevant +5. **Use proper formatting** - Help others help you by formatting code and logs properly +6. **Do not cross post** - Please avoid posting the same question in multiple places diff --git a/docs/source/about/support.md b/docs/source/about/support.md new file mode 100644 index 00000000..6395f852 --- /dev/null +++ b/docs/source/about/support.md @@ -0,0 +1,2 @@ +```{include} ../../../SUPPORT.md +``` diff --git a/docs/source/about/support.rst b/docs/source/about/support.rst deleted file mode 100644 index 26332b49..00000000 --- a/docs/source/about/support.rst +++ /dev/null @@ -1,7 +0,0 @@ -Support -======= - -.. Warning:: We use GitHub issues exclusively for actionable bug reports. Low effort issues will be immediately closed. - Spamming the GitHub repo or organization will result in a ban. - -Our available support methods are listed in our `Support Center `__. diff --git a/docs/source/developers/security.md b/docs/source/developers/security.md new file mode 100644 index 00000000..cef73528 --- /dev/null +++ b/docs/source/developers/security.md @@ -0,0 +1,2 @@ +```{include} ../../../SECURITY.md +``` diff --git a/docs/source/toc.rst b/docs/source/toc.rst index ae73de29..a01d2aa0 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -19,3 +19,4 @@ developers/code_of_conduct developers/contributing developers/repository_standards + developers/security