This is an automated email from the ASF dual-hosted git repository.
erickramirezau pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/cassandra-website.git
The following commit(s) were added to refs/heads/trunk by this push:
new 9fcbde2cd WEBSITE - Added guide for Asking Good Questions
9fcbde2cd is described below
commit 9fcbde2cdb779f0ee313f2a77e8cfd85d2006cae
Author: Erick Ramirez <[email protected]>
AuthorDate: Thu Aug 25 14:02:02 2022 +0000
WEBSITE - Added guide for Asking Good Questions
patch by Erick Ramirez, Bowen Song; reviewed by Ekaterina Dimitrova for
CASSANDRA-17859
Co-authored by Erick Ramirez <[email protected]>
Co-authored by Bowen Song <[email protected]>
---
.../community/community-ask_good_questions.jpg | Bin 0 -> 61882 bytes
.../ROOT/pages/community/ask_good_questions.adoc | 82 +++++++++++++++++++++
2 files changed, 82 insertions(+)
diff --git
a/site-content/source/modules/ROOT/images/community/community-ask_good_questions.jpg
b/site-content/source/modules/ROOT/images/community/community-ask_good_questions.jpg
new file mode 100644
index 000000000..c82fe8137
Binary files /dev/null and
b/site-content/source/modules/ROOT/images/community/community-ask_good_questions.jpg
differ
diff --git
a/site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc
b/site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc
new file mode 100644
index 000000000..fa9bfb650
--- /dev/null
+++ b/site-content/source/modules/ROOT/pages/community/ask_good_questions.adoc
@@ -0,0 +1,82 @@
+= Asking Good Questions in Community Forums
+: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, application logs and operating system
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 many 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 network. Please do not cross-post the same question to other channels
such as Slack or the mailing lists.
+
+- For *developer questions* including data modeling, coding, drivers,
https://stackoverflow.com/questions/ask?tags=cassandra[please ask on Stack
Overflow^].
+- For *admin or ops questions* including installation, upgrades, repairs,
please ask on https://dba.stackexchange.com/questions/ask?tags=cassandra[DBA
Stack Exchange^].
+
+Show your support for the community and follow the `cassandra` tag by clicking
on the blue *Watch tag* button on
https://stackoverflow.com/questions/tagged/cassandra[Stack Overflow^] and
https://dba.stackexchange.com/questions/tagged/cassandra[Stack Exchange^]!
+
+For broad, opinion-based questions, general discussions, ask how to get help,
or receive announcements, mailto:[email protected][please
subscribe to the user mailing list^]. Security issues need to be reported to
the https://www.apache.org/security/projects.html[Apache Security Team^].
+
+'''
+
+Hopefully you found this guide helpful. But it is just a guide – there are no
strict rules for asking questions. The community is here to help for everyone's
benefit. So go ahead, how we can help you today?
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
