[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: |
|
||||||||
| Epic Link: | CDRIVER-4546 | ||||||||
| Quarter: | FY24Q1 | ||||||||
| Description |
|
The install docs are currently split into several top-level sections:
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:
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:
Add a very minimal Sphinx extension sufficient to resolve references to
To support fully-offline builds of the documentation, vendor external |