Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-10587

Create documentation for the Azure extension

    • Type: Icon: New Feature New Feature
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • WT11.2.0, 7.0.0-rc0
    • Affects Version/s: None
    • Component/s: None
    • Labels:
      None
    • 5
    • 2023-02-23 "Stoney Baloney", 2023-03-21 Ellen Ripley

      Create documentation for the Azure storage source that includes the following information:

      1. Introduction
        This section should describe the purpose of the extension and it's functionality within WiredTiger.
      2. Build
        This section should describe how to build WiredTiger with the extension enabled. Be specific with version requirements for both the platform and any installed software.
      3. Development
        This section should describe what an engineer needs to set up and install to develop locally. The instructions should work for all platforms supported by the extension (e.g. Linux, Mac, Windows). Be specific with version requirements for both the platform and any installed software.
      4. Unit Testing
        This section should describe how to run the Azure unit tests from a developer machine and how a developer can add additional tests for the extension.
      5. Evergreen Testing
        This section should describe the tasks defined in evergreen.yml for testing the extension code (that a developer would include in patch builds) and how a developer can add additional evergreen tests to the extension.

      The documentation should be written as a README.md file in the  wiredtiger/ext/storage_sources/azure_store directory.

      Before submitting a PR for review, ask at least one WiredTiger engineer (who is not working on the project) to work through the instructions in your documentation.

            Assignee:
            lachlan.ting@mongodb.com Lachlan Ting (Inactive)
            Reporter:
            tammy.bailey@mongodb.com Tammy Bailey (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: