CDRIVER-5565 remove non-API docs (#1600)

* libmongoc: remove links to content moved to mongodb.com

The API and APM docs are linked to from mongodb.com.

* libmongoc: remove no-longer-referenced files

* libmongoc: remove `genindex`

The index page only shows one entry for `mongoc_kms_credentials_provider_callback_fn`.

* libmongoc: link to `MongoDB C Driver` page

* libmongoc: fix links to `queryable-encryption`

* libmongoc: fix links to `authentication`

* libmongoc: fix links to `bulk`

* libmongoc: fix links to `client-side-field-level-encryption`

* libmongoc: fix links to `configuring_tls`

* libmongoc: fix links to `connection-pooling`

* libmongoc: fix links to `in-use-encryption`

* libmongoc: fix links to `manage-collection-indexes`

* libmongoc: fix links to ``setting_collation_order`

* libmongoc: fix links to `tutorial_crud_operations`

* libmongoc: fix link to `bulk_operation_bypassing_document_validation`

* libmongoc: fix links to `cursors_tailable`

* libbson: remove links to content moved to mongodb.com

The API docs are linked to from mongodb.com.

* libbson: link to `MongoDB C Driver` page

* libbson: remove no-longer-referenced files

* libbson: fix links to `errors`

* libmongoc: fix links to `bson:errors`

* libmongoc: fix links to `bson:lifetimes`

* homepage: link to `MongoDB C Driver` page

* libmongoc: remove no-longer-used images

* libmongoc: remove unreferenced include

* update links in README

* update link in CONTRIBUTING.md

* fix links to community forums

* add missing "the"

Co-authored-by: Roberto C. Sánchez <[email protected]>

* fix `setting_collation_order_` links

Co-authored-by: Roberto C. Sánchez <[email protected]>

* fix `setting_collation_order_` in `generate-opts.py`

---------

Co-authored-by: Roberto C. Sánchez <[email protected]>

Author: kevinAlbs

CONTRIBUTING.md

@@ -15,7 +15,7 @@ The mongo-c-driver has a few guidelines that help direct the process.
 ### Portability
 
 mongo-c-driver is portable software. It needs to run on a multitude of
-[Supported Platforms](https://mongoc.org/libmongoc/current/installing.html#supported-platforms).
+[Supported Platforms](https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/ref/platforms/).
 
 
 ### Licensing

README.rst

@@ -73,7 +73,7 @@ information:
 
   Can you tell me what I need to install? Thanks!
 
-.. _MongoDB Community Forums: https://community.mongodb.com/tags/c/drivers-odms-connectors/7/c-driver
+.. _MongoDB Community Forums: https://www.mongodb.com/community/forums/tags/c/data/drivers/7/c-driver
 
 Security Vulnerabilities
 ------------------------
@@ -87,12 +87,12 @@ Installation
 ============
 
 Detailed installation instructions are in the manual:
-https://www.mongoc.org/libmongoc/current/installing.html
+https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/tutorials/obtaining-libraries/
 
 
 Resources
 ============
 
-* `Getting Started Tutorial <https://mongoc.org/libmongoc/current/tutorial.html>`_.
+* `Getting Started Tutorial <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/tutorial>`_.
 * `MongoDB C Driver Examples <https://github.com/mongodb/mongo-c-driver/tree/master/src/libmongoc/examples>`_.
-* Tutorials, videos, and code examples using the MongoDB C Driver can also be found in the `MongoDB Developer Center <https://www.mongodb.com/developer/languages/c/>`_.
+* Tutorials, videos, and code examples using the MongoDB C Driver can also be found in the `MongoDB Developer Center <https://www.mongodb.com/developer/languages/c/>`_.

build/generate-opts.py

@@ -120,7 +120,7 @@ def __init__(self, items, **defaults):
 
 collation_option = ('collation', {
     'type': 'document',
-    'help': 'Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.'
+    'help': 'Configure textual comparisons. See `Setting Collation Order <setting_collation_order_>`_, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.'
 })
 
 array_filters_option = ('arrayFilters', {

build/sphinx/homepage-config/conf.py

@@ -60,6 +60,11 @@ def setup(app):
 html_use_smartypants = False
 html_show_sourcelink = False
 html_use_index = False
+rst_prolog = rf"""
+
+.. _mongodb_docs_cdriver: https://www.mongodb.com/docs/languages/c/c-driver/current/
+
+"""
 
 html_sidebars = {
     '**': []

build/sphinx/homepage-config/index.rst

@@ -1,12 +1,14 @@
-MongoDB C Driver
-================
+MongoDB C Driver - API
+======================
 
 **A Cross Platform MongoDB Client Library for C**
 
 The MongoDB C Driver, also known as "libmongoc", is a library for using MongoDB from C applications, and for writing MongoDB drivers in higher-level languages.
 
 It depends on `libbson <libbson/current/index.html>`_ to generate and parse BSON documents, the native data format of MongoDB.
 
+This site documents the API. For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.
+
 Download
 --------
 
@@ -15,18 +17,16 @@ Latest release: :download-link:`mongoc`
 Documentation
 -------------
 
-`Installation <libmongoc/current/installing.html>`_
-
-`Tutorial <libmongoc/current/tutorial.html>`_
+For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.
 
-`libmongoc reference <libmongoc/current/index.html>`_
+- `libmongoc API documentation <libmongoc/current/index.html>`_
 
-`libbson reference <libbson/current/index.html>`_
+- `libbson API documentation <libbson/current/index.html>`_
 
 How To Ask For Help
 -------------------
 
-For help using the driver: `MongoDB Community Forums <https://community.mongodb.com/tags/c/drivers-odms-connectors/7/c-driver>`_.
+For help using the driver: `MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/data/drivers/7/c-driver>`_.
 
 To file a bug or feature request: `MongoDB Jira Issue Tracker <https://jira.mongodb.org/browse/CDRIVER>`_.
 

src/libbson/doc/bson_error_t.rst

@@ -23,7 +23,7 @@ Description
 
 The :symbol:`bson_error_t` structure is used as an out-parameter to pass error information to the caller. It should be stack-allocated and does not requiring freeing.
 
-See :doc:`Handling Errors <errors>`.
+See `Handling Errors <errors_>`_.
 
 .. only:: html
 

src/libbson/doc/conf.py

@@ -35,6 +35,14 @@
 
 html_use_index = False
 
+rst_prolog = rf"""
+
+.. _mongodb_docs_cdriver: https://www.mongodb.com/docs/languages/c/c-driver/current/
+
+.. _errors: https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/tutorials/errors/
+
+"""
+
 
 def add_canonical_link(app, pagename, templatename, context, doctree):
     link = f'<link rel="canonical" href="https://www.mongoc.org/libbson/current/{pagename}"/>'

src/libbson/doc/creating.rst

@@ -1,27 +1,15 @@
-libbson
-=======
+libbson - API
+=============
 
 A Cross Platform BSON Library for C
 
+This site documents the API. For tutorials, guides, and explainers, see `MongoDB C Driver <mongodb_docs_cdriver_>`_.
+
 Introduction
 ------------
 
 libbson builds, parses, and iterates `BSON <http://bsonspec.org>`_ documents, the native data format of MongoDB. It also converts BSON to and from JSON, and provides a platform compatibility layer for `the MongoDB C Driver <https://www.mongoc.org/>`_.
 
-.. toctree::
-  :titlesonly:
-
-  tutorial
-
-.. toctree::
-  :titlesonly:
-
-  guides
-
-.. toctree::
-  :titlesonly:
-
-  cross-platform-notes
 
 .. toctree::
   :titlesonly: