Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project doc analyses: drop numbered folders/files #265

Open
chalin opened this issue Jul 25, 2024 · 2 comments
Open

Project doc analyses: drop numbered folders/files #265

chalin opened this issue Jul 25, 2024 · 2 comments
Labels
Docs analysis CNCF technical documentation assistance

Comments

@chalin
Copy link
Collaborator

chalin commented Jul 25, 2024

@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 chalin added the Docs analysis CNCF technical documentation assistance label Jul 25, 2024
@nate-double-u
Copy link
Member

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.

@chalin
Copy link
Collaborator Author

chalin commented Jul 25, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs analysis CNCF technical documentation assistance
Projects
None yet
Development

No branches or pull requests

2 participants