[CDRIVER-3034] Reorganize installation documentation Created: 21/Mar/19  Updated: 28/Oct/23  Resolved: 05/Sep/23

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.25.0

Type: Task Priority: Major - P3
Reporter: Jeremy Mikola Assignee: Colby Pike
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
is related to CDRIVER-3022 mongo-c-driver-1.14.0: wrong version ... Closed
Epic Link: CDRIVER-4546
Quarter: FY24Q1

 Description   

The install docs are currently split into several top-level sections:

  • Installing libmongoc via package manager
  • Installing libbson via package manager
  • Building on Unix
  • Building on macOS
  • Building on Windows (various configurations)

The Unix and macOS sections discuss how to obtain the driver sources from a release tarball, but this isn't specified for Windows. Also, some Windows-specific commands appear under the Unix section.

roberto.sanchez proposed we reorganize the documentation under the following sections:

  • Getting the code
    • From Git (and generating version info)
    • Release tarball
  • Building the code
    • Subsection for each platform

Package installation instructions can likely remain as a separate, top-level section since that would bypass steps to download code and compile.



 Comments   
Comment by Kevin Albertson [ 05/Sep/23 ]

Resolved by https://github.com/mongodb/mongo-c-driver/pull/1371

Comment by Githook User [ 11/Aug/23 ]

Author:

{'name': 'vector-of-bool', 'email': 'vectorofbool@gmail.com', 'username': 'vector-of-bool'}

Message: CDRIVER-3034 New Installation/Getting-Started Documentation Pages (#1371)

  • New documentation with new theming
  • Prettier structure and output:
  • Use subdirectories for organization.
  • Import sphinx-design, which gives us useful components for richer HTML output.
  • Migrate most of the installation docs away:
  • New install docs and "supported platforms" have been refactored and
    replaced.
  • The old "installing" page has been detached from the ToC and is now
    a placeholder referencing the new documentation pages. This will allow
    existing links in the wild to continue to work, while making the page
    itself invisible in the ToC tree.
  • Create a howto on selecting an installation location
  • Clean up and clarify platform support
  • No dep on sphinxcontrib-moderncmakedomain:

Add a very minimal Sphinx extension sufficient to resolve references to
the CMake Sphinx object inventory. We don't need any more features for
now.

  • Fix up package builds to install sphinx-design deps
  • Vendor external inventories semi-automatically.

To support fully-offline builds of the documentation, vendor external
documentation inventories for intersphinx. These can be updated by
passing '-D update_external_inventories=1' to the sphinx-build command
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/2dc7efb8809421cd9fc4eaec23e1fd5dcd414af7

Generated at Wed Feb 07 21:16:58 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.