Readme for mongodb-js/kerberos/ should clearly state which platforms are officially supported vs experiemental

XMLWordPrintableJSON

    • Type: Sub-task
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • 0
    • Not Needed
    • None
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Use Case

      As a... _developer of https://github.com/mongodb-js/kerberos/_
      I want... to understand how the package is supported across platforms
      So that... I will know the level of support to expect and to provide.

      User Experience

      • What is the desired/expected outcome for the user once this ticket is implemented?
        Developers will know what platforms are supported and at which levels. When adding a new platform, the developer can be explicit about the expected level of platform support.

      Dependencies

      Risks/Unknowns

      • What could go wrong while implementing this change? (e.g., performance, inadvertent behavioral changes in adjacent functionality, existing tech debt, etc)
        Doc change, no risk
      • Is there an opportunity for better cross-driver alignment or testing in this area?
        Not really
      • Is there an opportunity to improve existing documentation on this subject?
        Yup, this is the opportunity.

      Acceptance Criteria

      Implementation Requirements

      Testing Requirements

      • unit test, spec test sync, etc
        None

      Documentation Requirements

      • DOCSP ticket, API docs, etc

      Follow Up Requirements

      • additional tickets to file, required releases, etc
        Help https://github.com/mongodb-js/kerberos/pull/295 get merged with the new addition being experimental
      • if node behavior differs/will differ from other drivers, confirm with dbx devs what standard to aim for and what plan, if any, exists to reconcile the diverging behavior moving forward

            Assignee:
            Pavel Safronov
            Reporter:
            Pavel Safronov
            Daria Pardue
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: