Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit 52da253

Browse files
authored
Merge pull request #334 from cloudant/update-doc-links
Updated deprecated docs.cloudant.com links
2 parents eda73e4 + 125bede commit 52da253

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

CHANGES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Unreleased
22
==========
33
- [NEW] Added ``Result.all()`` convenience method.
44
- [IMPROVED] Updated ``posixpath.join`` references to use ``'/'.join`` when concatenating URL parts.
5+
- [IMPROVED] Updated documentation by replacing deprecated Cloudant links with the latest Bluemix links.
56

67
2.6.0 (2017-08-10)
78
==================

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Related Documentation
5555
=====================
5656

5757
* `Cloudant Python client library docs (readthedocs.io) <http://python-cloudant.readthedocs.io>`_
58-
* `Cloudant documentation <http://docs.cloudant.com/>`_
59-
* `Cloudant for developers <https://cloudant.com/for-developers/>`_
58+
* `Cloudant documentation <https://console.bluemix.net/docs/services/Cloudant/cloudant.html#overview>`_
59+
* `Cloudant Learning Center <https://developer.ibm.com/clouddataservices/cloudant-learning-center/>`_
6060

6161
===========
6262
Development

src/cloudant/database.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,7 @@ def get_list_function_result(self, ddoc_id, list_name, view_name, **kwargs):
811811
# Process data (in text format).
812812
813813
For more detail on list functions, refer to the
814-
`Cloudant list documentation <https://docs.cloudant.com/
814+
`Cloudant list documentation <https://console.bluemix.net/docs/services/Cloudant/api/
815815
design_documents.html#list-functions>`_.
816816
817817
:param str ddoc_id: Design document id used to get result.
@@ -849,7 +849,7 @@ def get_show_function_result(self, ddoc_id, show_name, doc_id):
849849
# Process data (in text format).
850850
851851
For more detail on show functions, refer to the
852-
`Cloudant show documentation <https://docs.cloudant.com/
852+
`Cloudant show documentation <https://console.bluemix.net/docs/services/Cloudant/api/
853853
design_documents.html#show-functions>`_.
854854
855855
:param str ddoc_id: Design document id used to get the result.
@@ -897,7 +897,7 @@ def update_handler_result(self, ddoc_id, handler_name, doc_id=None, data=None, *
897897
data={'month': 'July'})
898898
899899
For more details, see the `update handlers documentation
900-
<https://docs.cloudant.com/design_documents.html#update-handlers>`_.
900+
<https://console.bluemix.net/docs/services/Cloudant/api/design_documents.html#update-handlers>`_.
901901
902902
:param str ddoc_id: Design document id used to get result.
903903
:param str handler_name: Name used in part to identify the
@@ -970,7 +970,8 @@ def share_database(self, username, roles=None):
970970
971971
:param str username: Cloudant user to share the database with.
972972
:param list roles: A list of
973-
`roles <https://docs.cloudant.com/authorization.html#roles>`_
973+
`roles
974+
<https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#roles>`_
974975
to grant to the named user.
975976
976977
:returns: Share database status in JSON format

src/cloudant/design_document.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def validate_doc_update(self):
6868
ddoc.save()
6969
7070
For more details, see the `Update Validators documentation
71-
<https://docs.cloudant.com/design_documents.html#update-validators>`_.
71+
<https://console.bluemix.net/docs/services/Cloudant/api/design_documents.html#update-validators>`_.
7272
7373
:returns: Dictionary containing update validator functions
7474
"""
@@ -104,7 +104,7 @@ def filters(self):
104104
:func:`~cloudant.database.CouchDatabase.changes`
105105
106106
For more details, see the `Filter functions documentation
107-
<https://docs.cloudant.com/design_documents.html#filter-functions>`_.
107+
<https://console.bluemix.net/docs/services/Cloudant/api/design_documents.html#filter-functions>`_.
108108
109109
:returns: Dictionary containing filter function names and functions
110110
as key/value
@@ -179,10 +179,10 @@ def st_indexes(self):
179179
Once the Cloudant Geo index is saved to the remote database, you can
180180
query the index with a GET request. To issue a request against the
181181
``_geo`` endpoint, see the steps outlined in the `endpoint access
182-
documentation <getting_started.html#endpoint-access>`_.
182+
<getting_started.html#endpoint-access>`_ section.
183183
184184
For more details, see the `Cloudant Geospatial
185-
documentation <https://docs.cloudant.com/geo.html>`_.
185+
documentation <https://console.bluemix.net/docs/services/Cloudant/api/cloudant-geo.html>`_.
186186
187187
:return: Dictionary containing Cloudant Geo names and index objects
188188
as key/value
@@ -241,7 +241,7 @@ def rewrites(self):
241241
rewritten as ``/$DATABASE/_design/doc/_rewrite/new?k=v``.
242242
243243
For more details on URL rewriting, see the `rewrite rules
244-
documentation <https://docs.cloudant.com/design_documents.html
244+
documentation <https://console.bluemix.net/docs/services/Cloudant/api/design_documents.html
245245
#rewrite-rules>`_.
246246
247247
:returns: List of dictionaries containing rewrite rules as key/value

0 commit comments

Comments
 (0)