[mapserver-dev] Versioned MapServer Docs?

[Jeff McKenna]

I have been doing the cleanup for announcements constantly, but a 
cleanup of the downloads page is a good idea, maybe separating it like 
the announcements.

I also want to mention here that it is important to place the version 
added near the title of that parameter, otherwise it is below the 
explanation and can confuse the reader which parameter it applies to. 
Here is proper example:

ENCODING [string]
     .. versionadded:: 7.0


I remember spending much effort on that recently, cleaning that up.

-jeff



On 2021-03-18 5:39 p.m., Even Rouault wrote:
> If we keep a single version for simplicity, we could however decide to 
> clean up a bit the doc content to remove mentions of outdated versions 
> to avoid cluttering it. There is little point in mentioning any version 
> older than let's say 5? years ago. I've done that a bit in the GDAL docs 
> a few months ago, removing any mention of GDAL < 2, considering that all 
> people looking at the docs would have at least GDAL 2.x something 
> available, or if they use antiquated stuff, too bad for them.
> 
> Looking a bit at download artifacts, for MapServer we could decide for 
> example that the baseline is MapServer 6.4 (or possibly even 7.0 for 
> simplicity), and remove any mention of that or older versions (except in 
> RFCs that are reflective of history)
> 
> "grep -r versionadded en" in the doc repository shows a number of things 
> of the 4.x, 5.x or early 6.x eras.  'grep -ri "since version" en' shows 
> also a number of potential cleanups.
> 
> Even
> 
> Le 18/03/2021 à 21:15, Jeff McKenna a écrit :
>> My preference has always been for Option#1, as it is much easier to 
>> maintain in my experience, as it is stated clearly as deprecated at 
>> the parameter level in the document.
>>
>> Speaking openly here, if I was paid fulltime to manage the docs and 
>> all the different build versions of the docs, and publishing them 
>> online, I could see how that would be possible; but as we are made up 
>> of volunteers, I would prefer to keep the single version updated with 
>> references to when the feature was added (what MapServer version), and 
>> if it is deprecated.  I remember recently spending much effort on that 
>> in-line versioning improvements, I think that is working nicely now.
>>
>> -jeff
>>
>>
>>