Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-5123

mongodb-client-encryption docs generation broken

XMLWordPrintableJSON

    • 1
    • Not Needed
    • 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?

      The documentation generation process for `mongodb-client-encryption` is broken.  `npm run docs` will delete all documentation from the readme, instead of adding the newly generated docs.

      The command works when run manually (`npx jsdoc2md --template etc/README.hbs --plugin dmd-clear --files lib/*/.js > README.md`), but fails when run with `npm`.

      acceptance criteria

      • determine the root cause of the failure to generate docs
      • fix the documentation generation

       

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: