Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-3034

Reorganize installation documentation

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Major - P3
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs
    • Labels:
      None

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jmikola Jeremy Mikola
                Participants:
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: