Release notes

[jmakeig]

• High-level description
• Most important new/changed functionality
• Detailed change log
• Links to docs, tutorials, MLU, etc.

[jmakeig]

@wooldridge Whose responsibility is this? Docs? QA? Dev?

[wooldridge]

@jmakeig, I can take a stab at this. Will solicit input from @kcoleman-marklogic.

[jmakeig]

It doesn't need a lot of details or “marketing”, just an accounting of what’s changed for developers. The Data Hub Framework has a good example.

[kcoleman-marklogic]

You can take a look at the README from the Java Client API, too. It hasn't been updated for this release yet, but the past releases are entirely suitable references.

[jmakeig]

@wooldridge In the interest of operating more like other projects on GitHub, can we move the release-specific stuff out of the main README and put it into the release landing page? I wouldn’t expect the README to change much from release-to-release:

• What is this thing?
• How do I install it?
• What’s the Day 0 “Hello, world!” interaction
• Where can I go for more information?
• Legal disclaimers

[wooldridge]

I created a draft release page for the 2.0.0 release:

https://github.com/marklogic/node-client-api/releases

I added the compatibility info and new features there. Also included a link to the complete changelog, which will work after 2.0.0 is cut

I updated the README to remove the compatilibility info for 2.0.0 and the new features, which were moved to the release page:

https://github.com/marklogic/node-client-api/blob/develop/README.md

Also added new items to the resources list (e.g., MLU resources) and made minor edits across the board.

[kcoleman-marklogic]

Looks good to me, but I have one question:

Are we going to leave the EA releases on the Releases page? They seem more like internal detritus than anything else.