Post-donation doc updates #1262
Conversation
| 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>`_. |
There was a problem hiding this comment.
CLA no longer applies, and somehow we missed the fact that the relevant anchor in README-dev.rst had changed to "tests" a long time ago.
| * 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 |
There was a problem hiding this comment.
The wheel building process is now managed by Github Actions rather than Travis CI. This should be addressed in a more comprehensive way when python-driver-wheels is donated.
| python -m SimpleHTTPServer | ||
|
|
||
| Then, browse to `localhost:8000 <http://localhost:8000>`_. | ||
|
|
There was a problem hiding this comment.
Documentor isn't relevant anymore. We need to figure out how we want to render docs for this project; Sphinx is a possibility but Documentor isn't.
| 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:: |
| * also test all event loops | ||
|
|
||
| * Update the wheels building repo to support that version: | ||
| https://github.com/datastax/python-driver-wheels |
There was a problem hiding this comment.
This will be changed based on how CI is implemented for this project. The old model of managing Jenkins runners won't be in use here.
| 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/>`_. |
There was a problem hiding this comment.
@michaelsembwever We still reference the Google Group under "Mailing list" for the Java driver... I'd like to change that to something like this so that we can start pointing people to ASF Slack. Any objections?
| 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>`_. |
There was a problem hiding this comment.
The link pointed to in the "Error Handling" section above no longer works. There's an ongoing discussion around removing this section entirely for the Java driver as well.
|
@millerjp I'm curious whether you have any feedback on this as well |
|
@absurdfarce is cassandra/datastax/insights needed anymore? |
|
It's not needed at all @bschoening; Insights has been defunct for some time. I've actually created tickets in all the drivers to remove Insights support; PYTHON-1415 is the relevant ticket for the Python driver. It hasn't exactly been an urgent concern but there's no question that (a) it's taking up some amount of cognitive load and (b) it's completely unnecessary. Would be nice to get that removed at some point in the future. |
patch by Bret McGuire; reviewed by Bret McGuire and Brad Schoening reference: apache#1262
absurdfarce
force-pushed
the
post-donation-doc-updates
branch
from
2540358 to
cbc14c3
Compare
2 participants
Fixing up a few things that need to be tweaked now that this project has been donated to the ASF.