CDRIVER-5565 remove non-API docs #1600
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The API and APM docs are linked to from mongodb.com.
The index page only shows one entry for `mongoc_kms_credentials_provider_callback_fn`.
The API docs are linked to from mongodb.com.
rcsanchez97
approved these changes
May 15, 2024
Co-authored-by: Roberto C. Sánchez <[email protected]>
Co-authored-by: Roberto C. Sánchez <[email protected]>
|
Merging. The I expect it is unrelated to this PR. |
kevinAlbs
added a commit
that referenced
this pull request
May 16, 2024
* 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]>
|
Yeah, that failure looks completely unrelated. I will take a look at the task status on the waterfall and confirm. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Rendered pages for the libmongoc and libbson projects are viewable from the Files tab of the make-docs Evergreen task.
Background & Motivation
Documentation has been migrated as part of DOCSP-29036. The DBX C/C++ team is expected to continue owning the API documentation.
CONTRIBUTING.md describes building docs with poetry. I use
sphinx-autobuild, which starts a local server and auto-reloads: