cfdocs icon indicating copy to clipboard operation
cfdocs copied to clipboard

Engine notes on per version base

Open shaedrich opened this issue 7 years ago • 4 comments

  • Change string to struct
  • So we can add a version history for engine

shaedrich avatar Feb 15 '18 14:02 shaedrich

I'd like to avoid these kinds of breaking changes to the format. For two reasons, first it breaks any code that was written that might rely on it, and second it requires us to make a big reformat to all the existing docs.

Two ways I can think of that might be better:

  1. Adding a history to the engines struct:

history: [ { version: "9.0.1", description: "Added xyz" } ]

  1. Add engines key to the params - then you can automatically extract the history when each argument or attribute was added. You could still support history key there to say things like version 10 added this option.

pfreitag avatar Mar 01 '18 15:03 pfreitag

Would be okay. Since 2. includes 1. we should take 2.

shaedrich avatar Mar 01 '18 15:03 shaedrich

@pfreitag Should we implement it like this?

shaedrich avatar Oct 25 '18 09:10 shaedrich

Hmm so do you think we still need the history support if we add engines key to the params?

I think adding engines key to params is a good idea for sure. Just not sure if we need history if they types of things you would be adding are added support for XYZ argument. I'd rather make sure that data gets accessable to a program (eg xyz param has min_version of 2016 on ACF and 5 on lucee).

pfreitag avatar Nov 01 '18 14:11 pfreitag