From 7a7207757cb826d6443b531bcfaf770f749b1127 Mon Sep 17 00:00:00 2001 From: "E. Cleopatra" <32180937+PROTechThor@users.noreply.github.com> Date: Thu, 8 Apr 2021 07:10:22 +0100 Subject: [PATCH 1/5] new: [doc] Add links to help, support and... discussion venues --- _pages/support.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 _pages/support.md diff --git a/_pages/support.md b/_pages/support.md new file mode 100644 index 0000000..ca3a036 --- /dev/null +++ b/_pages/support.md @@ -0,0 +1,69 @@ +# Help, Support, and Forums + +Help and support for MISP is available from the [documentation](https://www.circl.lu/doc/misp/), [GitHub issues](https://github.com/MISP/MISP/issues), and [Gitter rooms](https://gitter.im/orgs/MISP/rooms) which are explained below. The MISP Project does not offer paid support services. + +If you’re looking for known issues or would like to file a bug report, please see the [issue tracker](https://github.com/MISP/MISP/issues). These issues are constantly being updated and may contain workarounds for problems that you’re experiencing, so it’s worth searching the issue tracker as a first step. + +## Staying safe + +The Gitter rooms are open to the public and their contents are crawled by search engines and archived by third-party services outside of our control. +Therefore, do not post anything that you are not comfortable seeing discussed in public. +If confidentiality is a concern, send an email to info@circ.lu, encrypted with our GPG fingerprint ([22BD 4CD5](http://pgp.circl.lu/pks/lookup?op=index&search=%0A0xCA572205C0024E06BA70BE89EAADCFFC22BD4CD5)). + +The MISP community includes people from all walks of life and from around the world. +Individuals differ in areas of experience and technical expertise. +You will come into contact with others whose views and agendas differ from your own. +Everyone is free to write what they please, as long as it doesn’t violate our [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md). +Be friendly and open, but do not believe everything you read. Use good judgment, and be especially careful when following instructions (e.g., sharing files) given by others on the lists. + +## Discussion guidelines + +MISP discussions mainly take place on the [MISP/MISP](https://gitter.im/MISP/MISP), [MISP/Support](https://gitter.im/MISP/Support), [MISP/Docker](https://gitter.im/MISP/Docker), [MISP/misp-cloud](https://gitter.im/MISP/misp-cloud) and [MISP/Sharing](https://gitter.im/MISP/Sharing) Gitter rooms, all of which are explained below. +Most questions should be directed to the [MISP/Support](https://gitter.im/MISP/Support) room. +Discussions also take place on GitHub issues. + +Please do not send questions to individual MISP developers. +By sending messages to the appropriate rooms, you are not only giving others a chance to help you, but you may also be helping others by starting a public discussion about a shared problem or interest. + +These discussion venues are open places where people freely come together to discuss MISP and voluntarily help each other out of mutual interest and good will. +They are not your personal, paid support service. +No one owes you a reply or is obliged to help you solve your problems. +Nonetheless, there are many things you can do to make it more likely that you will receive a reply. +The MISP community is fortunate to have a lot friendly and knowledgeable people who enjoy corresponding on these discussion channels The vast majority of them will be happy to help you if you follow these simple guidelines: + +- **Be polite and respectful:** Remember, no one here is obliged to reply to you. If you are rude and disrespectful, you are very likely to be ignored. +- **Be concise:** Include only essential information. If you ramble, it will be easier to skip over you and help someone else who gets right to the point. +- **Help us help you:** Tell us what you’ve already tried, and which documentation pages you’ve already read. Think of your readers. What essential information would they require in order to be able to help you? Make sure to include that information in your message. Read this article: [Ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html). +- **Be patient:** If it seems like your messages to the rooms are consistently being ignored, ensure you’re following the guidelines above. If you’re already doing so but still not getting any replies, then it’s likely that no one who knows the answer has had time to reply yet. Remember that the developers are very busy working on MISP, and can no answer every question. +- **Be a good community member:** As with any social community, members earn different reputations for themselves over time. Those who have shown themselves to be good community members through their past contributions have earned our good will, and we will be especially eager to help them and collaborate with them. If you are new to the community, you should understand that it may take time for you to earn the good will of others. This does not mean that you will not receive help. On the contrary, we are lucky to have a community that helps complete strangers, including many who post anonymously. You can read our project’s [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md) for more information. +- **Report issues and submit changes in the right places:** The Gitter rooms are good places to ask questions and discuss things. However, if you’re submitting a more formal report, we’d prefer that you submit it to the appropriate GitHub issue tracker, so that it doesn’t get overlooked. Likewise, if you see that something in the documentation should be changed, don’t simply point it out in a discussion venue. Instead, [submit the change](https://github.com/MISP/misp-book/contributing.md). +- **Moderation:** The moderation team aims to enforce our [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md). Beyond this, users should not expect any specific action from the moderation team. Specifically, users should not request that posts or messages be deleted or edited by a moderator. Users are reminded that, in most venues, anything posted will be sent out as an email to other others, and these emails cannot be deleted from others’ inboxes. +- **Suggestions:** We are generally open to hearing suggestions for new features. Our roadmap is based on requests from people who use MISP. However, it is rather unlikely that we will change our schedule in order to accommodate an individual request. If there’s a particular feature you’d like to see in MISP, a much more effective way to make it happen is to [contribute a patch]() that implements it. We happily accept such contributions, provided they meet our standards. Please note, however, that it’s always a good idea to field a discussion of your idea on the [MISP/MISP Gitter room](https://gitter.im/MISP/MISP) or by creating a GitHub issue before putting in a lot of hard work on something that we may not be able or willing to accept. + +## Gitter + +This section covers each of our individual rooms, with details about the purpose of each list and how to use it. To join the room on Gitter, click the "Join" button at the bottom of the page. If you prefer, you can view all these rooms on Matrix by clicking the `[m]` button on the navigation bar. + +- **[MISP/MISP](https://gitter.im/MISP/MISP):** This room is meant for general MISP discussions, particularly for MISP developers and development-related questions. This room is primarily intended for people who are interested in contributing to MISP or who are willing to learn more about its implementation. Examples of topics and questions suitable for this room include: + - Questions about why we made certain implementation decisions. For example: “Why did you implement XYZ this way and not the other way?” + - Questions about code layout and where code is for certain functionality. + - Discussions about proposed new features and patches. For example: “I would like to implement feature XYZ.” + - Security discussions which are relevant to MISP in some way. +- **[MISP/Support](https://gitter.im/MISP/Support):** This room is for helping users solve various daily problems with MISP. This is the ultimate support channel for all things MISP. Come prepared with log files if appropriate. Please try searching the archives of the channel before sending a question. In addition, please make sure that you have read and understood the [documentation](https://www.circl.lu/doc/misp/) prior to posting to the room. Examples of topics or questions suitable for this list include: + - Installation problems + - Questions of the form: “How do I…?” +- **[MISP/Sharing](https://gitter.im/MISP/Sharing):** This channel is for general discussions on threat intelligence sharing topics. +- **[MISP/Docker](https://gitter.im/MISP/Docker):** This room is for conversations related to [MISP Docker](https://github.com/MISP/misp-docker) or using MISP on Docker. +- **[MISP/misp-cloud](https://gitter.im/MISP/misp-cloud):** This room is meant for convos about [MISP Cloud](https://github.com/MISP/misp-cloud) or using MISP on a cloud environment. + +## GitHub issues + +You can also ask questions by creating an issue on the appropriate GitHub repo. In the MISP core repository, use the [Support issue template](https://github.com/MISP/MISP/blob/2.4/.github/ISSUE_TEMPLATE/support_request.md) when seeking support. + +To be clear, GitHub issues is not a replacement for the [MISP/Support](https://gitter.im/MISP/Support) room. This is simply an additional place for discussion. Certain types of discussions naturally lend themselves more to GitHub issues or to forums, and different types of users prefer different venues. We’ve heard from some users who find the Gitter to be a bit intimidating or who may feel that their message may get lost in the thousands of messages. Others want more selective control over topic notifications. Some users simply appreciate the ability to add a “reaction” to a message instead of having to add an entirely new reply. Whatever your reasons, it’s up to you to decide where and how you want to join the conversation. + +## Social media + +The MISP Project has a presence on [Twitter (MISPProject)](https://twitter.com/MISPProject). + +Generally speaking, this is not intended to be a primary support venue. (Those would be [MISP/Support Gitter room]() and the issue tracker.) Rather, these are primarily intended to be a way to more widely disseminate news related to MISP. If you use Twitter, you may find it convenient to follow the MISP Project there as a way of receiving MISP news. From cc2bea779b6c738d29562f52611fed66ddda9c2d Mon Sep 17 00:00:00 2001 From: "E. Cleopatra" <32180937+PROTechThor@users.noreply.github.com> Date: Mon, 12 Apr 2021 09:49:59 +0100 Subject: [PATCH 2/5] chg: [header] Add link to support page --- _includes/header.html | 1 + 1 file changed, 1 insertion(+) diff --git a/_includes/header.html b/_includes/header.html index 9b2698e..ad0d43c 100755 --- a/_includes/header.html +++ b/_includes/header.html @@ -72,6 +72,7 @@
  • Governance
  • Contributing
  • Contributors
    • +
  • Support
  • License
    • From cfbca156d85ad675501ff8ea5024b4eb3551299a Mon Sep 17 00:00:00 2001 From: "E. Cleopatra" <32180937+PROTechThor@users.noreply.github.com> Date: Mon, 12 Apr 2021 09:56:48 +0100 Subject: [PATCH 3/5] chg [doc] Fix grammatical errors --- _pages/support.md | 48 ++++++++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/_pages/support.md b/_pages/support.md index ca3a036..ed6d1f0 100644 --- a/_pages/support.md +++ b/_pages/support.md @@ -1,8 +1,10 @@ # Help, Support, and Forums -Help and support for MISP is available from the [documentation](https://www.circl.lu/doc/misp/), [GitHub issues](https://github.com/MISP/MISP/issues), and [Gitter rooms](https://gitter.im/orgs/MISP/rooms) which are explained below. The MISP Project does not offer paid support services. +Help and support for MISP is available from the [documentation](https://www.circl.lu/doc/misp/), [GitHub issues](https://github.com/MISP/MISP/issues), and [Gitter rooms](https://gitter.im/orgs/MISP/rooms) which are explained below. +The MISP Project does not offer paid support services. -If you’re looking for known issues or would like to file a bug report, please see the [issue tracker](https://github.com/MISP/MISP/issues). These issues are constantly being updated and may contain workarounds for problems that you’re experiencing, so it’s worth searching the issue tracker as a first step. +If you’re looking for known issues or would like to file a bug report, please see the [issue tracker](https://github.com/MISP/MISP/issues). +These issues are constantly being updated and may contain workarounds for problems that you’re experiencing, so it’s worth searching the issue tracker as a first step. ## Staying safe @@ -14,7 +16,8 @@ The MISP community includes people from all walks of life and from around the wo Individuals differ in areas of experience and technical expertise. You will come into contact with others whose views and agendas differ from your own. Everyone is free to write what they please, as long as it doesn’t violate our [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md). -Be friendly and open, but do not believe everything you read. Use good judgment, and be especially careful when following instructions (e.g., sharing files) given by others on the lists. +Be friendly and open, but do not believe everything you read. +Use good judgment, and be especially careful when following instructions (e.g., sharing files) given by others on the lists. ## Discussion guidelines @@ -25,31 +28,33 @@ Discussions also take place on GitHub issues. Please do not send questions to individual MISP developers. By sending messages to the appropriate rooms, you are not only giving others a chance to help you, but you may also be helping others by starting a public discussion about a shared problem or interest. -These discussion venues are open places where people freely come together to discuss MISP and voluntarily help each other out of mutual interest and good will. +These discussion venues are open places where people freely come together to discuss MISP and voluntarily help each other out of mutual interest and goodwill. They are not your personal, paid support service. No one owes you a reply or is obliged to help you solve your problems. Nonetheless, there are many things you can do to make it more likely that you will receive a reply. -The MISP community is fortunate to have a lot friendly and knowledgeable people who enjoy corresponding on these discussion channels The vast majority of them will be happy to help you if you follow these simple guidelines: +The MISP community is fortunate to have a lot of friendly and knowledgeable people who enjoy corresponding on these discussion channels The vast majority of them will be happy to help you if you follow these simple guidelines: - **Be polite and respectful:** Remember, no one here is obliged to reply to you. If you are rude and disrespectful, you are very likely to be ignored. - **Be concise:** Include only essential information. If you ramble, it will be easier to skip over you and help someone else who gets right to the point. -- **Help us help you:** Tell us what you’ve already tried, and which documentation pages you’ve already read. Think of your readers. What essential information would they require in order to be able to help you? Make sure to include that information in your message. Read this article: [Ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html). -- **Be patient:** If it seems like your messages to the rooms are consistently being ignored, ensure you’re following the guidelines above. If you’re already doing so but still not getting any replies, then it’s likely that no one who knows the answer has had time to reply yet. Remember that the developers are very busy working on MISP, and can no answer every question. -- **Be a good community member:** As with any social community, members earn different reputations for themselves over time. Those who have shown themselves to be good community members through their past contributions have earned our good will, and we will be especially eager to help them and collaborate with them. If you are new to the community, you should understand that it may take time for you to earn the good will of others. This does not mean that you will not receive help. On the contrary, we are lucky to have a community that helps complete strangers, including many who post anonymously. You can read our project’s [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md) for more information. -- **Report issues and submit changes in the right places:** The Gitter rooms are good places to ask questions and discuss things. However, if you’re submitting a more formal report, we’d prefer that you submit it to the appropriate GitHub issue tracker, so that it doesn’t get overlooked. Likewise, if you see that something in the documentation should be changed, don’t simply point it out in a discussion venue. Instead, [submit the change](https://github.com/MISP/misp-book/contributing.md). -- **Moderation:** The moderation team aims to enforce our [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md). Beyond this, users should not expect any specific action from the moderation team. Specifically, users should not request that posts or messages be deleted or edited by a moderator. Users are reminded that, in most venues, anything posted will be sent out as an email to other others, and these emails cannot be deleted from others’ inboxes. +- **Help us help you:** Tell us what you’ve already tried, and which documentation pages you’ve already read. Think of your readers. What essential information would they require to be able to help you? Make sure to include that information in your message. Read this article: [Ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html). +- **Be patient:** If it seems like your messages to the rooms are consistently being ignored, ensure you’re following the guidelines above. If you’re already doing so but still not getting any replies, then it’s likely that no one who knows the answer has had time to reply yet. Remember that the developers are very busy working on MISP, and can not answer every question. +- **Be a good community member:** As with any social community, members earn different reputations for themselves over time. Those who have shown themselves to be good community members through their past contributions have earned our goodwill, and we will be especially eager to help them and collaborate with them. If you are new to the community, you should understand that it may take time for you to earn the goodwill of others. This does not mean that you will not receive help. On the contrary, we are lucky to have a community that helps strangers, including many who post anonymously. +- **Report issues and submit changes in the right places:** The Gitter rooms are good places to ask questions and discuss things. However, if you’re submitting a more formal report, we’d prefer that you submit it to the appropriate GitHub issue tracker so that it doesn’t get overlooked. Likewise, if you see that something in the documentation should be changed, don’t simply point it out in a discussion venue. Instead, [submit the change](https://github.com/MISP/misp-book/contributing.md). +- **Moderation:** The moderation team aims to enforce our [Code of Conduct](https://github.com/MISP/MISP/blob/2.4/code_of_conduct.md). Beyond this, users should not expect any specific action from the moderation team. Specifically, users should not request that posts or messages be deleted or edited by a moderator. Users are reminded that, in most venues, anything posted will be sent out as an email to others, and these emails cannot be deleted from others’ inboxes. - **Suggestions:** We are generally open to hearing suggestions for new features. Our roadmap is based on requests from people who use MISP. However, it is rather unlikely that we will change our schedule in order to accommodate an individual request. If there’s a particular feature you’d like to see in MISP, a much more effective way to make it happen is to [contribute a patch]() that implements it. We happily accept such contributions, provided they meet our standards. Please note, however, that it’s always a good idea to field a discussion of your idea on the [MISP/MISP Gitter room](https://gitter.im/MISP/MISP) or by creating a GitHub issue before putting in a lot of hard work on something that we may not be able or willing to accept. ## Gitter -This section covers each of our individual rooms, with details about the purpose of each list and how to use it. To join the room on Gitter, click the "Join" button at the bottom of the page. If you prefer, you can view all these rooms on Matrix by clicking the `[m]` button on the navigation bar. +This section covers each of our rooms, with details about the purpose of each list and how to use it. +To join a room on Gitter, click the "Join" button at the bottom of the page. +If you prefer, you can view all these rooms on Matrix by clicking the `[m]` button on the navigation bar. - **[MISP/MISP](https://gitter.im/MISP/MISP):** This room is meant for general MISP discussions, particularly for MISP developers and development-related questions. This room is primarily intended for people who are interested in contributing to MISP or who are willing to learn more about its implementation. Examples of topics and questions suitable for this room include: - Questions about why we made certain implementation decisions. For example: “Why did you implement XYZ this way and not the other way?” - Questions about code layout and where code is for certain functionality. - Discussions about proposed new features and patches. For example: “I would like to implement feature XYZ.” - - Security discussions which are relevant to MISP in some way. -- **[MISP/Support](https://gitter.im/MISP/Support):** This room is for helping users solve various daily problems with MISP. This is the ultimate support channel for all things MISP. Come prepared with log files if appropriate. Please try searching the archives of the channel before sending a question. In addition, please make sure that you have read and understood the [documentation](https://www.circl.lu/doc/misp/) prior to posting to the room. Examples of topics or questions suitable for this list include: + - Security discussions that are relevant to MISP in some way. +- **[MISP/Support](https://gitter.im/MISP/Support):** This room is for helping users solve various daily problems with MISP. This is the ultimate support channel for all things MISP. Come prepared with log files if appropriate. Please try searching the archives of the channel before sending a question. Also, please make sure that you have read and understood the [documentation](https://www.circl.lu/doc/misp/) before posting it to the room. Examples of topics or questions suitable for this list include: - Installation problems - Questions of the form: “How do I…?” - **[MISP/Sharing](https://gitter.im/MISP/Sharing):** This channel is for general discussions on threat intelligence sharing topics. @@ -58,12 +63,21 @@ This section covers each of our individual rooms, with details about the purpose ## GitHub issues -You can also ask questions by creating an issue on the appropriate GitHub repo. In the MISP core repository, use the [Support issue template](https://github.com/MISP/MISP/blob/2.4/.github/ISSUE_TEMPLATE/support_request.md) when seeking support. +You can also ask questions by creating an issue on the appropriate GitHub repo. +In the MISP core repository, use the [Support issue template](https://github.com/MISP/MISP/blob/2.4/.github/ISSUE_TEMPLATE/support_request.md) when seeking support. -To be clear, GitHub issues is not a replacement for the [MISP/Support](https://gitter.im/MISP/Support) room. This is simply an additional place for discussion. Certain types of discussions naturally lend themselves more to GitHub issues or to forums, and different types of users prefer different venues. We’ve heard from some users who find the Gitter to be a bit intimidating or who may feel that their message may get lost in the thousands of messages. Others want more selective control over topic notifications. Some users simply appreciate the ability to add a “reaction” to a message instead of having to add an entirely new reply. Whatever your reasons, it’s up to you to decide where and how you want to join the conversation. +To be clear, GitHub issues is not a replacement for the [MISP/Support](https://gitter.im/MISP/Support) room. +This is simply an additional place for discussion. +Certain types of discussions naturally lend themselves more to GitHub issues or forums, and different types of users prefer different venues. +We’ve heard from some users who find the Gitter to be a bit intimidating or who may feel that their message may get lost in the thousands of messages. +Others want more selective control over topic notifications. +Whatever your reasons, it’s up to you to decide where and how you want to join the conversation. ## Social media -The MISP Project has a presence on [Twitter (MISPProject)](https://twitter.com/MISPProject). +MISP Project has a presence on [Twitter (@MISPProject)](https://twitter.com/MISPProject). -Generally speaking, this is not intended to be a primary support venue. (Those would be [MISP/Support Gitter room]() and the issue tracker.) Rather, these are primarily intended to be a way to more widely disseminate news related to MISP. If you use Twitter, you may find it convenient to follow the MISP Project there as a way of receiving MISP news. +Generally speaking, this is not intended to be a primary support venue. +(Those would be [MISP/Support Gitter room]() and the issue tracker.) +Rather, these are primarily intended to be a way to more widely disseminate news related to MISP. +If you use Twitter, you may find it convenient to follow the MISP Project there as a way of receiving MISP news. From 28b91f8e805233cd11e725fe665fd4ffb07d56e9 Mon Sep 17 00:00:00 2001 From: "E. Cleopatra" <32180937+PROTechThor@users.noreply.github.com> Date: Mon, 12 Apr 2021 10:04:44 +0100 Subject: [PATCH 4/5] chg: [doc] Add layout, page, permalink, toc --- _pages/support.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_pages/support.md b/_pages/support.md index ed6d1f0..078e4c0 100644 --- a/_pages/support.md +++ b/_pages/support.md @@ -1,3 +1,10 @@ +--- +layout: page +title: Help, Support, and Forums +permalink: /support/ +toc: true +--- + # Help, Support, and Forums Help and support for MISP is available from the [documentation](https://www.circl.lu/doc/misp/), [GitHub issues](https://github.com/MISP/MISP/issues), and [Gitter rooms](https://gitter.im/orgs/MISP/rooms) which are explained below. From 4c4e1f0f03374df988f0f1c60e88599521da259b Mon Sep 17 00:00:00 2001 From: "E. Cleopatra" <32180937+PROTechThor@users.noreply.github.com> Date: Mon, 12 Apr 2021 14:03:08 +0100 Subject: [PATCH 5/5] chg: [doc] Add link to paid support services --- _pages/support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_pages/support.md b/_pages/support.md index 078e4c0..cb1b2b5 100644 --- a/_pages/support.md +++ b/_pages/support.md @@ -8,7 +8,7 @@ toc: true # Help, Support, and Forums Help and support for MISP is available from the [documentation](https://www.circl.lu/doc/misp/), [GitHub issues](https://github.com/MISP/MISP/issues), and [Gitter rooms](https://gitter.im/orgs/MISP/rooms) which are explained below. -The MISP Project does not offer paid support services. +MISP Project [offers paid support services](https://www.misp-project.org/professional-services). If you’re looking for known issues or would like to file a bug report, please see the [issue tracker](https://github.com/MISP/MISP/issues). These issues are constantly being updated and may contain workarounds for problems that you’re experiencing, so it’s worth searching the issue tracker as a first step.