Porting notes / deprecation docs

[Frederik Schwarzer]

On 7/10/21 6:17 PM, Ahmad Samir wrote:
> On 10/07/2021 18:00, Frederik Schwarzer wrote:
>> Hi,
>>
>> as mentioned earlier, I would like to document classes/methods/etc that
>> are going to be deprecated during KF6 development.
>>
>> For that I scraped up all the deprecation macros from the frameworks and
>> edited them to be more unified.
>>
> 
> Good work, that must have been a huge task! (82 frameworks ... :)).

grep ran a few seconds to give me a 2600 lines text file, which I then 
had to edit to be more readable, which took me several hours. :)
The hard part is still about to come. :)


>> As for the location, I would probably start putting content in the
>> community wiki to a place like
>> https://community.kde.org/Frameworks/KF6_Porting_Notes. Does anyone see
>> a problem with that? Might is be better to write such docs in markdown
>> or restructured text for being better suited for a more modern location?
>>
> 
> A wiki page is not most friendly way of editing huge technical 
> documents. Personally, I think a markdown file in a git repo would be 
> great, and then it can be "published" to a wiki page or a static web 
> page on one of KDE's web sites. Or, we start with an markdown text file, 
> then after it's fleshed out / polished, put it in the wiki, 
> editing/adding a small section here or there would be easier. (But I do 
> prefer text files, much easier to edit in my usual editor of choice).

Yes, I agree. A text file in Git is also better for tracking changes.


> FWIW, there is supposed to be a KF6 meeting soon[1]. Not sure if we'll 
> start this week or the next one though.

I have the Mondays on my calendar now. :)