You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by sl...@apache.org on 2016/06/27 18:34:27 UTC
[32/34] cassandra git commit: Add 'report bug' section
Add 'report bug' section
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/7988b3fc
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/7988b3fc
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/7988b3fc
Branch: refs/heads/trunk
Commit: 7988b3fcda4d7948f510b540a1c51fff3c910722
Parents: 02d2621
Author: Sylvain Lebresne <sy...@datastax.com>
Authored: Mon Jun 27 20:01:31 2016 +0200
Committer: Sylvain Lebresne <sy...@datastax.com>
Committed: Mon Jun 27 20:01:31 2016 +0200
----------------------------------------------------------------------
doc/source/bugs.rst | 17 ++++++++++++++---
doc/source/contactus.rst | 4 ++++
doc/source/cql/index.rst | 2 ++
doc/source/getting_started/drivers.rst | 2 ++
doc/source/getting_started/querying.rst | 22 ++++++++++++++++++----
5 files changed, 40 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/7988b3fc/doc/source/bugs.rst
----------------------------------------------------------------------
diff --git a/doc/source/bugs.rst b/doc/source/bugs.rst
index ef10aab..90efb14 100644
--- a/doc/source/bugs.rst
+++ b/doc/source/bugs.rst
@@ -14,7 +14,18 @@
.. See the License for the specific language governing permissions and
.. limitations under the License.
-Reporting bugs
---------------
+Reporting bugs and contributing
+===============================
-.. todo:: TODO
+If you encounter a problem with Cassandra, the first places to ask for help are the :ref:`user mailing list
+<mailing-lists>` and the ``#cassandra`` :ref:`IRC channel <irc-channels>`.
+
+If, after having asked for help, you suspect that you have found a bug in Cassandra, you should report it by opening a
+ticket through the `Apache Cassandra JIRA <https://issues.apache.org/jira/browse/CASSANDRA>`__. Please provide as much
+details as you can on your problem, and don't forget to indicate which version of Cassandra you are running and on which
+environment.
+
+If you would like to contribute, please check `the section on contributing
+<https://wiki.apache.org/cassandra/HowToContribute>`__ on the Cassandra wiki. Please note that the source of this
+documentation is part of the Cassandra git repository and hence contributions to the documentation should follow the
+same path.
http://git-wip-us.apache.org/repos/asf/cassandra/blob/7988b3fc/doc/source/contactus.rst
----------------------------------------------------------------------
diff --git a/doc/source/contactus.rst b/doc/source/contactus.rst
index ffd9d60..8d0f5dd 100644
--- a/doc/source/contactus.rst
+++ b/doc/source/contactus.rst
@@ -19,6 +19,8 @@ Contact us
You can get in touch with the Cassandra community either via the mailing lists or the freenode IRC channels.
+.. _mailing-lists:
+
Mailing lists
-------------
@@ -37,6 +39,8 @@ Subscribe by sending an email to the email address in the Subscribe links above.
email to confirm your subscription. Make sure to keep the welcome email as it contains instructions on how to
unsubscribe.
+.. _irc-channels:
+
IRC
---
http://git-wip-us.apache.org/repos/asf/cassandra/blob/7988b3fc/doc/source/cql/index.rst
----------------------------------------------------------------------
diff --git a/doc/source/cql/index.rst b/doc/source/cql/index.rst
index 718959c..00d90e4 100644
--- a/doc/source/cql/index.rst
+++ b/doc/source/cql/index.rst
@@ -14,6 +14,8 @@
.. See the License for the specific language governing permissions and
.. limitations under the License.
+.. _cql:
+
The Cassandra Query Language (CQL)
==================================
http://git-wip-us.apache.org/repos/asf/cassandra/blob/7988b3fc/doc/source/getting_started/drivers.rst
----------------------------------------------------------------------
diff --git a/doc/source/getting_started/drivers.rst b/doc/source/getting_started/drivers.rst
index d637a70..baec823 100644
--- a/doc/source/getting_started/drivers.rst
+++ b/doc/source/getting_started/drivers.rst
@@ -14,6 +14,8 @@
.. See the License for the specific language governing permissions and
.. limitations under the License.
+.. _client-drivers:
+
Client drivers
--------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/7988b3fc/doc/source/getting_started/querying.rst
----------------------------------------------------------------------
diff --git a/doc/source/getting_started/querying.rst b/doc/source/getting_started/querying.rst
index f73c106..55b162b 100644
--- a/doc/source/getting_started/querying.rst
+++ b/doc/source/getting_started/querying.rst
@@ -17,9 +17,18 @@
Inserting and querying
----------------------
-cqlsh is a command line shell for interacting with Cassandra through CQL (the Cassandra Query Language). It is shipped
-with every Cassandra package, and can be found in the bin/ directory alongside the cassandra executable. cqlsh utilizes
-the Python native protocol driver, and connects to the single node specified on the command line. For example::
+The API to Cassandra is :ref:`CQL <cql>`, the Cassandra Query Language. To use CQL, you will need to connect to the
+cluster, which can be done:
+
+- either using cqlsh,
+- or through a client driver for Cassandra.
+
+CQLSH
+^^^^^
+
+cqlsh is a command line shell for interacting with Cassandra through CQL. It is shipped with every Cassandra package,
+and can be found in the bin/ directory alongside the cassandra executable. It connects to the single node specified on
+the command line. For example::
$ bin/cqlsh localhost
Connected to Test Cluster at localhost:9042.
@@ -34,5 +43,10 @@ the Python native protocol driver, and connects to the single node specified on
(1 rows)
cqlsh>
-
See the :ref:`cqlsh section <cqlsh>` for full documentation.
+
+Client drivers
+^^^^^^^^^^^^^^
+
+A lot of client drivers are provided by the Community and a list of known drivers is provided in :ref:`the next section
+<client-drivers>`. You should refer to the documentation of each drivers for more information on how to use them.