cncf / toc

⚖️ The CNCF Technical Oversight Committee (TOC) is the technical governing body of the CNCF Foundation.
https://cncf.io
1.67k stars 631 forks source link

What: Formalize Technical paper (whitepaper) process #1408

Closed TheFoxAtWork closed 2 days ago

TheFoxAtWork commented 3 weeks ago

Why:

This change address the need by:

TheFoxAtWork commented 3 weeks ago

This is awesome. As someone who was close to both the WG Platforms White Paper and the lead on the WG Platforms Maturity Model this would have been immensely helpful and tracks a lot of what we did.

The one thing I see as a difference is that in both cases we had challenges with group writing and instead invested heavily in group commenting, editing, and adding. So the content rough-insection was a relative small group of people, but we spent a lot more time on thecollaborative reviewthrough tocommunity review` sections. The complete timeline suggested here is ~23 weeks which I do think is about what we took overall though so maybe it just all comes out in the wash?

That resonates with some of my experience developing technical papers in CNCF. Ultimately the rough-in usually ended with a strong core of individuals working through the content, and lots of engagement on the collaborative review portion. I think part of it is a learning opportunity for individuals that improves the clarity and understanding of deeply technical content. As far as timeline goes, its entirely dependent on the Paper Lead to drive. I've seen some done sooner, others take longer, the important thing is that a timeline is established to manage the paper towards completion.

zanetworker commented 2 weeks ago

Thanks, Emily. We have been discussing this topic in the AI WG for quite sometime. Aside from how to approach a technical paper and guidelines around writing/best practices, I think we still need concrete actions for getting the paper formally published/approved. For example, do we need to create service tickets, who should do that? Is there a CNCF peer-review required? how to request that?...

TheFoxAtWork commented 2 weeks ago

Thanks, Emily. We have been discussing this topic in the AI WG for quite sometime. Aside from how to approach a technical paper and guidelines around writing/best practices, I think we still need concrete actions for getting the paper formally published/approved. For example, do we need to create service tickets, who should do that? Is there a CNCF peer-review required? how to request that?...

@zanetworker thank you for pointing raising this! I've incorporated at lines 124-132 & 165

TheFoxAtWork commented 1 week ago

@raravena80 added additional info in the "README" outline and created another section further down on keeping it relevant.

dims commented 2 days ago

LGTM