[16.07] curated release notes for 16.07

[martenson]

@galaxyproject/core please comment, commit or PR against martenson/galaxy

TODO: choose second highlight

[martenson]

note this has been switched to release_16.07 from master

[bgruening]

I think DTD, Azure blob objectstore or the Kubernetes job runner are significant and awesome new features.

[jmchilton]

+1 to DTD - it seems the most broadly applicable and stable thing to report on.

[nsoranzo]

This should be:

Update to latest stable release
  .. code-block:: shell

      % git checkout release_16.07 && git pull --ff-only origin release_16.07

Note that a git was missing after &&

[martenson]

highlight added, git commands updated

[jmchilton]

You added more categories (API and collections?) - we used to do things that way but I really like the clean flatter list - the categories just seem very arbitrary.

[martenson]

@jmchilton I ordered the PRs based on subjective importance for the highlighted group. then I order them by type in this group - and they ended up in these groups, so I gave them headings 😢

[afgane]

I feel that the highlighted items should have a wiki page with usage docs created for them rather than just pointing to a very dev-centric PRs. For example, reading "Install via conda, PR #2554" means very little to someone not involved with the development of that particular feature.

[martenson]

@afgane for Conda we have accompanying 7 page document we will add. For others there should have been documentation but...nobody writes it we do not write it much.

[jmchilton]

@martenson I'd just eliminate the headings - I like them being ordered together.

@martenson I agree with @afgane's comment - I have a commit in progress to give some of these items more user-centric names. It is a good reminder to everyone who contributes to Galaxy to do this when naming PRs though so this doesn't need to be done at this stage. Hope this is okay @martenson - I can PR it instead of direct commit if you wish.

[afgane]

For others there should have been documentation but...nobody writes it we do not write it much.

My point exactly - it feels like the docs for the highlighted items at least should be a requirement of the PR just like passing the tests is.

[martenson]

@afgane These are community PRs, we shouldn't enforce community contributors to write extensive documentation. We should probably do it ourselves instead if it is not provided.

There is decent documentation for the DTD, I will dig it up and make it coherent on wiki somewhere.

Chat is an admin (and experimental) feature. @erasche @bgruening @anuprulez could you do a small writeup of how to turn it on and use it please?

[martenson]

@jmchilton direct commit is fine; I am not sold on dropping the headings though

[afgane]

I'm of the opinion that if someone is going to take the time to develop a feature and PR it so that it gets included in the main distribution, they would then like to see the feature used. Requiring the docs might be a strong word but what about strongly encouraging it at least? They way I see it, if a feature is not documented, it might as well not exist.

[martenson]

@afgane The definition of 'documented' is variable. There is often good information about how to use it in the PR itself, or in sample files. I agree that highlighted features should have coherent docs outside of PR and am working towards that for 16.07.

[jmchilton]

I'd encourage discussions about changes in policy related to documentation of contributions to be filed as a modification to the contributing document or in an issue - this doesn't seem the appropriate forum.

[nsoranzo]

s/Impelement/Implement/

[martenson]

I moved these following 3 to the end of the highlighted section since they are release highlights already

[nsoranzo]

s/ot/to/

[nsoranzo]

s/and/an/ I guess

[martenson]

I have reworded the Conda highlight to announce it as Beta and opt-in
#2826
#2834

[martenson]

this is waiting for #2844 and needs to be modified afterwards

[martenson]

This is now ready to be merged.