Create process to autodump/prettify KEPs and annual reports

[nimbinatus]

Describe the issue

During a podcast recording, @mrbobbytables, @katcosgrove, and I were discussing how to make the KEPs and annual reports a bit more discoverable and comprehensible. We discussed having a pipeline that generated either PDFs or a website that aggregated the KEPs and reports in a more readable format for users to encourage people to read them and understand them. I'm opening this issue to at least get the conversation in writing and started.

/assign @nimbinatus /sig contributor-experience

[nimbinatus]

Holding; steering is discussing this one with some draft proposals.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[nimbinatus]

/remove-lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[samsonkolge]

@nimbinatus I am assuming that we need to automate the KEPs stored in here? IMO the report / pdf generation pipeline should get triggered whenever there is a merge to master.

[samsonkolge]

Proposal: Centralized Kubernetes KEP Site for Enhanced Discoverability and Accessibility

Background Kubernetes Enhancement Proposals (KEPs) are critical to the development and evolution of Kubernetes. Currently, KEPs are managed in the kubernetes/enhancements repository. While this structure is effective for version control, it lacks user-friendly discoverability and accessibility features that would encourage more widespread community engagement.

Objective This proposal aims to create a centralized, publicly accessible website that aggregates all KEPs and offers a more readable, searchable format. The website will be automatically updated upon any new merges to the KEP repository, ensuring the latest content is always available. The site will also provide the ability to download all KEPs as a single PDF.

Solution Overview Centralized Repository for Hosting the Site: A new repository (e.g., kubernetes/enhancements-site) will be created under the Kubernetes GitHub organization to host the website and manage the GitHub Pages deployment.

Automated CI/CD Pipeline: The kubernetes/enhancements repository will use GitHub Actions to automatically generate and deploy the site to the enhancements-site repository whenever a change is merged into master. The pipeline will use MkDocs, a static site generator, to render the KEPs in a readable format and deploy them to the gh-pages branch of the enhancements-site repository.

Key Features:

• Search and Navigation: The site will offer intuitive navigation with categorized KEPs and a search function to quickly locate relevant proposals.
• PDF Export: Users can download the entire set of KEPs as a single PDF.
• Responsive and Accessible Design: The site will be optimized for readability across devices and meet accessibility standards.

Benefits:

• Improved Discoverability: Users can easily browse and search for KEPs by SIG, status, or title.
• Centralized Access: A single authoritative location for all KEPs, improving accessibility and reducing confusion.
• Automatic Updates: The site stays up-to-date with every merge, requiring minimal manual intervention.

Implementation Plan

1. Create and Configure the enhancements-site Repository:
2. Set up GitHub Pages to deploy from the gh-pages branch.
3. Configure the CI/CD Pipeline in the Existing enhancements Repository:
4. Set up a GitHub Actions workflow to build the site and push it to the enhancements-site repository upon every merge to master.
5. Enhance the Site’s Navigation:
   • Develop a script to dynamically update the MkDocs configuration based on the directory structure of the KEPs.

Rollout and Communication:

• Announce the new site to the community through mailing lists and SIG meetings.
• Update documentation to reference the new KEP site as the primary resource.

Maintenance and Future Enhancements

• The CI/CD pipeline will handle routine updates, but periodic reviews and enhancements may be necessary.
• Future improvements could include better categorization, enhanced PDF generation, and deeper integration with other Kubernetes documentation.

Conclusion This proposal addresses the need for a more accessible and discoverable KEP resource. By leveraging existing tools and automating the deployment process, the community will benefit from a polished, user-friendly site that stays up to date with the latest developments in Kubernetes.

[palnabarun]

/remove-lifecycle rotten