ekaterinadimitrova2 commented on code in PR #169: URL: https://github.com/apache/cassandra-website/pull/169#discussion_r955127869
########## site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc: ########## @@ -0,0 +1,82 @@ += Ask Good Questions +:page-layout: basic +:description: A guide to asking good questions to get better answers. +:sectids!: + +== Welcome and thank you for being part of the Apache Cassandra community! + +:!figure-caption: +.Image credit: https://www.pexels.com/@diohasbi/[Dio Hasbi Saniskoro on Pexels^] +image::community/community-ask_good_questions.jpg[Supporting each other] + + + +Asking good questions will often get you a faster response and even better answers. So what makes a good question? This guide should help you draft a well-asked question. + +''' + +==== Before asking a question + +We encourage you to do a bit of research first. See if your question has already been answered in various channels: + +* For **developer questions** including coding or driver issues, https://stackoverflow.com/questions/tagged/cassandra[search on Stack Overflow^]. +* For **admin or ops questions** including installation or maintenance issues, https://dba.stackexchange.com/questions/tagged/cassandra[search on DBA Stack Exchange^]. +* Search the user mailing list archives. +* Search in the https://the-asf.slack.com/archives/CJZLTM05A[#cassandra channels on ASF Slack^] (requires https://s.apache.org/slack-invite[account signup^]). + +Make sure you check the Cassandra logs and application logs because the log entries often give clues. + +If you still need help, here are some things to consider when posting your question. + +==== Use a meaningful title or subject line + +Good: “Cassandra failed to start after upgrading from 3.11.9 to 4.0.1” + +Bad: “HELP!!! Cassandra doesn’t start” + +==== Explain the problem you're trying to solve + +Often users ask if it's good to change parameter X or if they should run command Y but this often isn't helpful. Instead, explain the issue you ran into and what outcome you're after so you'll be more likely to achieve it. + +Provide background information. For example, a node went down because of a hardware failure or you were patching the OS. Knowing how you ran into a problem makes it easier to help you. + +If you've tried some workarounds based on what you've researched on the internet, include the details in your question. It shows that you have made an effort to look for answers on your own. + +==== List software versions + +In a lot of cases, the answer depends on the version you're running. Include things like Cassandra version, Java version, driver/framework version (for example, or Java driver 4.11 or Spring Boot 3.3.1). + +==== Provide details of the error + +Don't just post the error and expect an answer. We often need the full error message and the full stack trace. And in order to decipher the stack trace, make sure you provide the version as above. + +==== Provide configuration details + +Note how you have configured cassandra.yaml (for example). It isn't necessary to post entire configuration files, just include the properties/items relevant to your question. + +Depending on your question, it might be relevant to describe your cluster's topology; number of nodes; whether the nodes are on-premise or in a public cloud; whether they are VMs, pods or bare-metal. + +==== Data or app issues + +For problematic queries, include the table schema and the full CQL query. + +For app-related problems, provide some minimal code that reproduces the issue. It would also help to provide sample data that illustrates the problem. + +List the expected result/output versus the actual result/output you got. + +''' + +==== Are you ready? + +For questions about developing apps or need help operating Cassandra, post on the Stack Exchange network. Please do not cross-post the same question to other channels such as Slack or the mailing lists. Review Comment: I am not sure we can advise against cross-posting until we have a bot and consolidated pipeline for questions/answers. In case someone totally messed up and they need answers I still feel Slack would be probably quicker. But you are more experienced with that so I will leave it to your judgement ########## site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc: ########## @@ -0,0 +1,82 @@ += Ask Good Questions +:page-layout: basic +:description: A guide to asking good questions to get better answers. +:sectids!: + +== Welcome and thank you for being part of the Apache Cassandra community! + +:!figure-caption: +.Image credit: https://www.pexels.com/@diohasbi/[Dio Hasbi Saniskoro on Pexels^] +image::community/community-ask_good_questions.jpg[Supporting each other] + + + +Asking good questions will often get you a faster response and even better answers. So what makes a good question? This guide should help you draft a well-asked question. + +''' + +==== Before asking a question + +We encourage you to do a bit of research first. See if your question has already been answered in various channels: + +* For **developer questions** including coding or driver issues, https://stackoverflow.com/questions/tagged/cassandra[search on Stack Overflow^]. +* For **admin or ops questions** including installation or maintenance issues, https://dba.stackexchange.com/questions/tagged/cassandra[search on DBA Stack Exchange^]. +* Search the user mailing list archives. +* Search in the https://the-asf.slack.com/archives/CJZLTM05A[#cassandra channels on ASF Slack^] (requires https://s.apache.org/slack-invite[account signup^]). + +Make sure you check the Cassandra logs and application logs because the log entries often give clues. + +If you still need help, here are some things to consider when posting your question. + +==== Use a meaningful title or subject line + +Good: “Cassandra failed to start after upgrading from 3.11.9 to 4.0.1” + +Bad: “HELP!!! Cassandra doesn’t start” + +==== Explain the problem you're trying to solve + +Often users ask if it's good to change parameter X or if they should run command Y but this often isn't helpful. Instead, explain the issue you ran into and what outcome you're after so you'll be more likely to achieve it. + +Provide background information. For example, a node went down because of a hardware failure or you were patching the OS. Knowing how you ran into a problem makes it easier to help you. + +If you've tried some workarounds based on what you've researched on the internet, include the details in your question. It shows that you have made an effort to look for answers on your own. + +==== List software versions + +In a lot of cases, the answer depends on the version you're running. Include things like Cassandra version, Java version, driver/framework version (for example, or Java driver 4.11 or Spring Boot 3.3.1). + +==== Provide details of the error + +Don't just post the error and expect an answer. We often need the full error message and the full stack trace. And in order to decipher the stack trace, make sure you provide the version as above. + +==== Provide configuration details + +Note how you have configured cassandra.yaml (for example). It isn't necessary to post entire configuration files, just include the properties/items relevant to your question. + +Depending on your question, it might be relevant to describe your cluster's topology; number of nodes; whether the nodes are on-premise or in a public cloud; whether they are VMs, pods or bare-metal. + +==== Data or app issues + +For problematic queries, include the table schema and the full CQL query. + +For app-related problems, provide some minimal code that reproduces the issue. It would also help to provide sample data that illustrates the problem. + +List the expected result/output versus the actual result/output you got. + +''' + +==== Are you ready? + +For questions about developing apps or need help operating Cassandra, post on the Stack Exchange network. Please do not cross-post the same question to other channels such as Slack or the mailing lists. Review Comment: Stack Network ########## site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc: ########## @@ -0,0 +1,82 @@ += Ask Good Questions +:page-layout: basic +:description: A guide to asking good questions to get better answers. +:sectids!: + +== Welcome and thank you for being part of the Apache Cassandra community! + +:!figure-caption: +.Image credit: https://www.pexels.com/@diohasbi/[Dio Hasbi Saniskoro on Pexels^] +image::community/community-ask_good_questions.jpg[Supporting each other] + + + +Asking good questions will often get you a faster response and even better answers. So what makes a good question? This guide should help you draft a well-asked question. + +''' + +==== Before asking a question + +We encourage you to do a bit of research first. See if your question has already been answered in various channels: + +* For **developer questions** including coding or driver issues, https://stackoverflow.com/questions/tagged/cassandra[search on Stack Overflow^]. +* For **admin or ops questions** including installation or maintenance issues, https://dba.stackexchange.com/questions/tagged/cassandra[search on DBA Stack Exchange^]. +* Search the user mailing list archives. +* Search in the https://the-asf.slack.com/archives/CJZLTM05A[#cassandra channels on ASF Slack^] (requires https://s.apache.org/slack-invite[account signup^]). + +Make sure you check the Cassandra logs and application logs because the log entries often give clues. Review Comment: Maybe in some cases also OS logs -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
