This is an automated email from the ASF dual-hosted git repository.
absurdfarce pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cassandra-python-driver.git
The following commit(s) were added to refs/heads/master by this push:
new 6f229a71 Updating a few docs after donation to the ASF. (#1262)
6f229a71 is described below
commit 6f229a71f38e94f8e1ace9c25d6f753cc987d000
Author: Bret McGuire <[email protected]>
AuthorDate: Fri Dec 5 15:02:28 2025 -0600
Updating a few docs after donation to the ASF. (#1262)
patch by Bret McGuire; reviewed by Bret McGuire and Brad Schoening
reference: https://github.com/apache/cassandra-python-driver/pull/1262
---
CONTRIBUTING.rst | 9 ++----
README-dev.rst | 96 ++++----------------------------------------------------
README.rst | 13 +++-----
3 files changed, 14 insertions(+), 104 deletions(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e5da81d7..f71ebabd 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -5,7 +5,8 @@ Contributions are welcome in the form of bug reports or pull
requests.
Bug Reports
-----------
-Quality bug reports are welcome at the `DataStax Python Driver JIRA
<https://datastax-oss.atlassian.net/browse/PYTHON>`_.
+Quality bug reports are welcome at the `CASSPYTHON project
<https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSPYTHON%20ORDER%20BY%20key%20DESC>`_
+of the ASF JIRA.
There are plenty of `good resources
<http://www.drmaciver.com/2013/09/how-to-submit-a-decent-bug-report/>`_
describing how to create
good bug reports. They will not be repeated in detail here, but in general,
the bug report include where appropriate:
@@ -18,11 +19,7 @@ good bug reports. They will not be repeated in detail here,
but in general, the
Pull Requests
-------------
If you're able to fix a bug yourself, you can `fork the repository
<https://help.github.com/articles/fork-a-repo/>`_ and submit a `Pull Request
<https://help.github.com/articles/using-pull-requests/>`_ with the fix.
-Please include tests demonstrating the issue and fix. For examples of how to
run the tests, consult the `dev README
<https://github.com/datastax/python-driver/blob/master/README-dev.rst#running-the-tests>`_.
-
-Contribution License Agreement
-------------------------------
-To protect the community, all contributors are required to `sign the DataStax
Contribution License Agreement <http://cla.datastax.com/>`_. The process is
completely electronic and should only take a few minutes.
+Please include tests demonstrating the issue and fix. For examples of how to
run the tests, consult the `dev README
<https://github.com/apache/cassandra-python-driver/blob/master/README-dev.rst#tests>`_.
Design and Implementation Guidelines
------------------------------------
diff --git a/README-dev.rst b/README-dev.rst
index c619b0be..939d3fa4 100644
--- a/README-dev.rst
+++ b/README-dev.rst
@@ -1,5 +1,7 @@
Releasing
=========
+Note: the precise details of some of these steps have changed. Leaving this
here as a guide only.
+
* Run the tests and ensure they all pass
* Update CHANGELOG.rst
* Check for any missing entries
@@ -13,7 +15,8 @@ Releasing
* Tag the release. For example: ``git tag -a 1.0.0 -m 'version 1.0.0'``
* Push the tag and new ``master``: ``git push origin 1.0.0 ; git push origin
master``
* Update the `python-driver` submodule of `python-driver-wheels`,
- commit then push. This will trigger TravisCI and the wheels building.
+ commit then push.
+* Trigger the Github Actions necessary to build wheels for the various
platforms
* For a GA release, upload the package to pypi::
# Clean the working directory
@@ -49,85 +52,12 @@ Releasing
* this is typically a matter of merging or rebasing onto master
* test and push updated branch to origin
-* Update the JIRA versions:
https://datastax-oss.atlassian.net/plugins/servlet/project-config/PYTHON/versions
+* Update the JIRA releases:
https://issues.apache.org/jira/projects/CASSPYTHON?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page
* add release dates and set version as "released"
* Make an announcement on the mailing list
-Building the Docs
-=================
-Sphinx is required to build the docs. You probably want to install through apt,
-if possible::
-
- sudo apt-get install python-sphinx
-
-pip may also work::
-
- sudo pip install -U Sphinx
-
-To build the docs, run::
-
- python setup.py doc
-
-Upload the Docs
-=================
-
-This is deprecated. The docs is now only published on
https://docs.datastax.com.
-
-To upload the docs, checkout the ``gh-pages`` branch and copy the entire
-contents all of ``docs/_build/X.Y.Z/*`` into the root of the ``gh-pages``
branch
-and then push that branch to github.
-
-For example::
-
- git checkout 1.0.0
- python setup.py doc
- git checkout gh-pages
- cp -R docs/_build/1.0.0/* .
- git add --update # add modified files
- # Also make sure to add any new documentation files!
- git commit -m 'Update docs (version 1.0.0)'
- git push origin gh-pages
-
-If docs build includes errors, those errors may not show up in the next build
unless
-you have changed the files with errors. It's good to occassionally clear the
build
-directory and build from scratch::
-
- rm -rf docs/_build/*
-
-Documentor
-==========
-We now also use another tool called Documentor with Sphinx source to build
docs.
-This gives us versioned docs with nice integrated search. This is a private
tool
-of DataStax.
-
-Dependencies
-------------
-Sphinx
-~~~~~~
-Installed as described above
-
-Documentor
-~~~~~~~~~~
-Clone and setup Documentor as specified in `the project
<https://github.com/riptano/documentor#installation-and-quick-start>`_.
-This tool assumes Ruby, bundler, and npm are present.
-
-Building
---------
-The setup script expects documentor to be in the system path. You can either
add it permanently or run with something
-like this::
-
- PATH=$PATH:<documentor repo>/bin python setup.py doc
-
-The docs will not display properly just browsing the filesystem in a browser.
To view the docs as they would be in most
-web servers, use the SimpleHTTPServer module::
-
- cd docs/_build/
- python -m SimpleHTTPServer
-
-Then, browse to `localhost:8000 <http://localhost:8000>`_.
-
Tests
=====
@@ -166,7 +96,7 @@ it with the ``PROTOCOL_VERSION`` environment variable::
Testing Multiple Python Versions
--------------------------------
-Use tox to test all of Python 3.9 through 3.13 and pypy (this is what TravisCI
runs)::
+Use tox to test all of Python 3.9 through 3.13 and pypy::
tox
@@ -223,17 +153,3 @@ An EAP release is only uploaded on a private server and it
is not published on p
python setup.py doc
* Upload the docs on the EAP download server.
-
-Adding a New Python Runtime Support
-===================================
-
-* Add the new python version to our jenkins image:
- https://github.com/riptano/openstack-jenkins-drivers/
-
-* Add the new python version in the Jenkinsfile and TravisCI configs as
appropriate
-
-* Run the tests and ensure they all pass
- * also test all event loops
-
-* Update the wheels building repo to support that version:
- https://github.com/datastax/python-driver-wheels
diff --git a/README.rst b/README.rst
index 955d0726..47b5593e 100644
--- a/README.rst
+++ b/README.rst
@@ -63,23 +63,20 @@ community) is now maintained as an integral part of this
package. Refer to
Contributing
------------
-See `CONTRIBUTING.md
<https://github.com/datastax/python-driver/blob/master/CONTRIBUTING.rst>`_.
-
-Error Handling
---------------
-While originally written for the Java driver, users may reference the
`Cassandra error handling done right blog
<https://www.datastax.com/blog/cassandra-error-handling-done-right>`_ for
resolving error handling scenarios with Apache Cassandra.
+See `CONTRIBUTING.rst
<https://github.com/datastax/python-driver/blob/master/CONTRIBUTING.rst>`_.
Reporting Problems
------------------
Please report any bugs and make any feature requests on the
-`JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_ issue tracker.
+`CASSPYTHON project
<https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSPYTHON%20ORDER%20BY%20key%20DESC>`_
+of the ASF JIRA.
If you would like to contribute, please feel free to open a pull request.
Getting Help
------------
-Your best options for getting help with the driver is the
-`mailing list
<https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
+You can talk about the driver, ask questions and get help in the
#cassandra-drivers channel on
+`ASF Slack <https://the-asf.slack.com/>`_.
License
-------
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
