Thanks for the proposal and for driving this Chesnay! It already looks much better.
There are some thoughts about that. The list of FLIPs that appears in the menu as part of the FLIP overview [1] exceeds 200 now which results in Confluence applying pagination. Users have to click an additional link to make newer FLIPs accessible in the menu. I was wondering whether we could also discuss coming up with a FLIP archive. Either we could change the sorting of the subpages (which would require a renaming of the FLIP template and may be something else to keep them in the top) or by introducing a subpage "Archived FLIPs" that could collect FLIPs that are declined/finished/out-dated. The goal is to have only newer/relevant FLIPs listed as 1st-level subpages in the FLIP overview menu. I'm wondering whether we could get rid of the FLIP ID counter on the FLIP overview page [1] as part of that. Right now, it's redundant information and it's not updated properly all the time resulting in duplicates or some miss in terms of FLIP ID. Hence, I guess, it's not of much help when trying to avoid duplicates. For the archiving approach, this would mean that we wouldn't allow archiving the FLIP with the highest ID. I would volunteer to execute this if we come to an agreement. [1] https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals On Mon, Sep 19, 2022 at 8:49 AM Chesnay Schepler <ches...@apache.org> wrote: > I've finished the restructuring over the weekend. > > @Ryan: I haven't organized FLIPs by topic, but it's possible to do that, > either via labels or by adding a sort of "Topic/Component" field to the > page properties and filtering on that. > If someone wants to do that go ahead, I don't wanna see another FLIP > page for a bit :D > (Note that filtering on labels is preferable because for some reason the > ToC throws up when you have 2 Page properties reports with the same > label set but different filters) > > On 16/09/2022 13:12, Ryan Skraba wrote: > > This sounds like an obvious improvement to save tedious labour -- at the > > same time, would this be something interesting to organize lists of FLIP > > pages around topics? If I'm interested in the connectors, for example. > > > > +1 and thanks, Ryan > > > > On Fri, Sep 16, 2022 at 12:53 PM Yun Tang <myas...@live.com> wrote: > > > >> +1, thanks for driving this, Chesnay! > >> > >> Best > >> Yun Tang > >> ________________________________ > >> From: Matthias Pohl <matthias.p...@aiven.io.INVALID> > >> Sent: Friday, September 16, 2022 18:21 > >> To: dev@flink.apache.org <dev@flink.apache.org> > >> Subject: Re: [DISCUSS] Restructure FLIP pages with page properties > >> > >> +1 Thanks for proposing that, Chesnay. I guess, it's a good idea to > reduce > >> efforts around documenting by removing duplicated content. > >> > >> On Fri, Sep 16, 2022 at 11:56 AM Chesnay Schepler <ches...@apache.org> > >> wrote: > >> > >>> Hello, > >>> > >>> The current FLIP overview page [1] is kind of a mess and inconvenient > to > >>> modify. It requires a fair amount of manual work to get right, > requiring > >>> updates in multiple places. > >>> > >>> I'd like to improve that, and experiment with the Page properties > >>> (Reports) and labels to auto-generate the overview page. > >>> > >>> I've already applied the changes to the Discarded FLIPs to that end, so > >>> have a look at the bottom of the overview page. > >>> > >>> In short, we can categorize FLIPs (what's currently done with the > >>> "Status" line in the FLIP) via labels, filter them in the overview > based > >>> on that, and then extract page properties (aka, a special table in the > >>> FLIP page) to populate a listing. > >>> > >>> The end goal is that we will never have to update the overview page > >>> manually. > >>> > >>> I'd volunteer to migrate all existing FLIP pages of course. > >>> > >>> - [1] > >>> > >>> > >> > https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals > >>> > > -- Best regards, Sergey