diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 397bb5b7..917db3e9 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -61,6 +61,7 @@ export const docsNavigation = [ { title: 'CLI', href: '/how-to/cli' }, { title: 'Delete your NetBird account', href: '/how-to/delete-account' }, { title: 'IdP sync', href: '/how-to/idp-sync' }, + { title: 'Report bugs and issues', href: '/how-to/report-bug-issues' }, ], }, diff --git a/src/pages/how-to/report-bug-issues.mdx b/src/pages/how-to/report-bug-issues.mdx new file mode 100644 index 00000000..194c3297 --- /dev/null +++ b/src/pages/how-to/report-bug-issues.mdx @@ -0,0 +1,46 @@ +# Report bugs and issues +NetBird offers different ways to report bugs and issues. For prompt and effective assistance, please provide detailed information as outlined in our bug/issue [reporting template](#reporting-template). + +For cloud users, you can report bugs and issues via email by sending an email to [support@nebtird.io](mailto:support@netbird.io), via [Github issues](https://github.com/netbirdio/netbird/issues/new/choose) or by joining our Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A). + +For on-premise users, you can report bugs and issues via [Github issues](https://github.com/netbirdio/netbird/issues/new/choose) or by joining our Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A). + +## Reporting Template +When reporting bugs and issues, please ensure you provide the following information: + + +**Describe the problem** + +A clear and concise description of what the problem is. + +**To Reproduce** + +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** + +A clear and concise description of what you expected to happen. + +**Are you using NetBird Cloud?** + +Please specify whether you use NetBird Cloud or self-host NetBird's control plane. + +**NetBird version** + +`netbird version` + +**NetBird status -d output:** + +If applicable, add the `netbird status -d' command output. + +**Screenshots** + +If applicable, add screenshots to help explain your problem. + +**Additional context** + +Add any other context about the problem here.