Skip to content

Commit 6f229a7

Browse files
authored
Updating a few docs after donation to the ASF. (#1262)
patch by Bret McGuire; reviewed by Bret McGuire and Brad Schoening reference: #1262
1 parent 7596cc9 commit 6f229a7

3 files changed

Lines changed: 14 additions & 104 deletions

File tree

CONTRIBUTING.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Contributions are welcome in the form of bug reports or pull requests.
55

66
Bug Reports
77
-----------
8-
Quality bug reports are welcome at the `DataStax Python Driver JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_.
8+
Quality bug reports are welcome at the `CASSPYTHON project <https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSPYTHON%20ORDER%20BY%20key%20DESC>`_
9+
of the ASF JIRA.
910

1011
There are plenty of `good resources <http://www.drmaciver.com/2013/09/how-to-submit-a-decent-bug-report/>`_ describing how to create
1112
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
1819
Pull Requests
1920
-------------
2021
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.
21-
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>`_.
22-
23-
Contribution License Agreement
24-
------------------------------
25-
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.
22+
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>`_.
2623

2724
Design and Implementation Guidelines
2825
------------------------------------

README-dev.rst

Lines changed: 6 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
Releasing
22
=========
3+
Note: the precise details of some of these steps have changed. Leaving this here as a guide only.
4+
35
* Run the tests and ensure they all pass
46
* Update CHANGELOG.rst
57
* Check for any missing entries
@@ -13,7 +15,8 @@ Releasing
1315
* Tag the release. For example: ``git tag -a 1.0.0 -m 'version 1.0.0'``
1416
* Push the tag and new ``master``: ``git push origin 1.0.0 ; git push origin master``
1517
* Update the `python-driver` submodule of `python-driver-wheels`,
16-
commit then push. This will trigger TravisCI and the wheels building.
18+
commit then push.
19+
* Trigger the Github Actions necessary to build wheels for the various platforms
1720
* For a GA release, upload the package to pypi::
1821

1922
# Clean the working directory
@@ -49,85 +52,12 @@ Releasing
4952
* this is typically a matter of merging or rebasing onto master
5053
* test and push updated branch to origin
5154

52-
* Update the JIRA versions: https://datastax-oss.atlassian.net/plugins/servlet/project-config/PYTHON/versions
55+
* Update the JIRA releases: https://issues.apache.org/jira/projects/CASSPYTHON?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page
5356

5457
* add release dates and set version as "released"
5558

5659
* Make an announcement on the mailing list
5760

58-
Building the Docs
59-
=================
60-
Sphinx is required to build the docs. You probably want to install through apt,
61-
if possible::
62-
63-
sudo apt-get install python-sphinx
64-
65-
pip may also work::
66-
67-
sudo pip install -U Sphinx
68-
69-
To build the docs, run::
70-
71-
python setup.py doc
72-
73-
Upload the Docs
74-
=================
75-
76-
This is deprecated. The docs is now only published on https://docs.datastax.com.
77-
78-
To upload the docs, checkout the ``gh-pages`` branch and copy the entire
79-
contents all of ``docs/_build/X.Y.Z/*`` into the root of the ``gh-pages`` branch
80-
and then push that branch to github.
81-
82-
For example::
83-
84-
git checkout 1.0.0
85-
python setup.py doc
86-
git checkout gh-pages
87-
cp -R docs/_build/1.0.0/* .
88-
git add --update # add modified files
89-
# Also make sure to add any new documentation files!
90-
git commit -m 'Update docs (version 1.0.0)'
91-
git push origin gh-pages
92-
93-
If docs build includes errors, those errors may not show up in the next build unless
94-
you have changed the files with errors. It's good to occassionally clear the build
95-
directory and build from scratch::
96-
97-
rm -rf docs/_build/*
98-
99-
Documentor
100-
==========
101-
We now also use another tool called Documentor with Sphinx source to build docs.
102-
This gives us versioned docs with nice integrated search. This is a private tool
103-
of DataStax.
104-
105-
Dependencies
106-
------------
107-
Sphinx
108-
~~~~~~
109-
Installed as described above
110-
111-
Documentor
112-
~~~~~~~~~~
113-
Clone and setup Documentor as specified in `the project <https://github.com/riptano/documentor#installation-and-quick-start>`_.
114-
This tool assumes Ruby, bundler, and npm are present.
115-
116-
Building
117-
--------
118-
The setup script expects documentor to be in the system path. You can either add it permanently or run with something
119-
like this::
120-
121-
PATH=$PATH:<documentor repo>/bin python setup.py doc
122-
123-
The docs will not display properly just browsing the filesystem in a browser. To view the docs as they would be in most
124-
web servers, use the SimpleHTTPServer module::
125-
126-
cd docs/_build/
127-
python -m SimpleHTTPServer
128-
129-
Then, browse to `localhost:8000 <http://localhost:8000>`_.
130-
13161
Tests
13262
=====
13363

@@ -166,7 +96,7 @@ it with the ``PROTOCOL_VERSION`` environment variable::
16696

16797
Testing Multiple Python Versions
16898
--------------------------------
169-
Use tox to test all of Python 3.9 through 3.13 and pypy (this is what TravisCI runs)::
99+
Use tox to test all of Python 3.9 through 3.13 and pypy::
170100

171101
tox
172102

@@ -223,17 +153,3 @@ An EAP release is only uploaded on a private server and it is not published on p
223153
python setup.py doc
224154

225155
* Upload the docs on the EAP download server.
226-
227-
Adding a New Python Runtime Support
228-
===================================
229-
230-
* Add the new python version to our jenkins image:
231-
https://github.com/riptano/openstack-jenkins-drivers/
232-
233-
* Add the new python version in the Jenkinsfile and TravisCI configs as appropriate
234-
235-
* Run the tests and ensure they all pass
236-
* also test all event loops
237-
238-
* Update the wheels building repo to support that version:
239-
https://github.com/datastax/python-driver-wheels

README.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,23 +63,20 @@ community) is now maintained as an integral part of this package. Refer to
6363

6464
Contributing
6565
------------
66-
See `CONTRIBUTING.md <https://github.com/datastax/python-driver/blob/master/CONTRIBUTING.rst>`_.
67-
68-
Error Handling
69-
--------------
70-
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.
66+
See `CONTRIBUTING.rst <https://github.com/datastax/python-driver/blob/master/CONTRIBUTING.rst>`_.
7167

7268
Reporting Problems
7369
------------------
7470
Please report any bugs and make any feature requests on the
75-
`JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_ issue tracker.
71+
`CASSPYTHON project <https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSPYTHON%20ORDER%20BY%20key%20DESC>`_
72+
of the ASF JIRA.
7673

7774
If you would like to contribute, please feel free to open a pull request.
7875

7976
Getting Help
8077
------------
81-
Your best options for getting help with the driver is the
82-
`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
78+
You can talk about the driver, ask questions and get help in the #cassandra-drivers channel on
79+
`ASF Slack <https://the-asf.slack.com/>`_.
8380

8481
License
8582
-------

0 commit comments

Comments
 (0)