techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard
verified publisher icon cncf

Project doc analyses: drop numbered folders/files

Open chalin opened this issue 1 year ago • 2 comments

@nate-double-u and I had the discussion at some point: why are we numbering project analysis folder/files? It's probably historical. I'd suggest that we adopt the "blog" convention of putting analyses into folders named by the year that the analysis is started and/or published. WDYT?

chalin avatar Jul 25 '24 22:07 chalin

I always thought that starting the numbering with 3 leading zeros was very optimistic 😅

I'd be fine with dropping the numbering system and adopting a blog-style organization that you suggest. Putting a table of contents style section in the techdocs/analyses/README.md would also help with findability.

nate-double-u avatar Jul 25 '24 22:07 nate-double-u

Eventually ("soon"?) we'd want this to be published as a Hugo site, so that we can get ToC and section-page lists generated automatically.

chalin avatar Jul 25 '24 22:07 chalin