Join GitHub today
Version Change Docs & Help #312
I wasn't sure whether this should go live immediately (it has some comments to-do, so maybe not), and also I included an extension to handle markdown tables, so made a branch instead.
This PR includes a new section in
This includes 3 new pages:
The first is more generic, and should include breaking changes as we make them, with instructions on how to update the call to get it working. It currently has two, I'm not sure if we need to go backwards, but thought it will be good going forward.
The second gives details on how to move from using
The third gives some guide as to how to figure out what versions of what work with what. Currently this assumes we are tying export JSON version to Auspice version, but this is currently under discussion. Whatever we choose, we can keep a record of this here, so that it's always easy to find and figure out.
The three tables are definitely redundant, but that's intentional, so it's easy as possible to figure out whatever direction you're trying to go.
I'll try to answer some of my own questions in 'How to Change Export Versions' soon. We should try to get these complete before we go live with augur v6/export v2/auspice 2.0.
We discussed this today at the Nextstrain meeting today and agreed it makes sense to merge this branch into the
I have updated them to better describe what's still outstanding and what needs to be done, and to update some decisions we've made since I've last updated.
I started working on describing how to use
This is almost done. I am waiting to merge until we have some final things clarified as far as how things override. To avoid having to re-write too often, it's currently a mis-mash of what I wrote during which approach... but this going to be confusing to people using it.
Once we get the override stuff finally sorted, it should be ready to merge as a guide (though almost certainly will not be final).
Are we including 'advanced config'/'second config' stuff in