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

KEP Overview #1110

Merged
merged 5 commits into from
Nov 28, 2019
Merged

KEP Overview #1110

merged 5 commits into from
Nov 28, 2019

Conversation

ANeumann82
Copy link
Member

What this PR does / why we need it:

As a new member to the project, I had/have a hard time getting an overview of work in progress, proposals, etc. defined in KEPs.

I think an overview in the KEP folder would help a lot to make them more accessible.

It might even be a good idea having different sections here, i.e.

  • Organizational
  • Implemented and Done
  • Future Features

Copy link
Contributor

@alenkacz alenkacz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not saying no, I just wonder what is the advantage of this to this? https://github.com/kudobuilder/kudo/tree/master/keps - is it just that the names of the files are not descriptive enough? I am just looking for a solution that would solve the problem but does not introduce another place where we need to list all keps (and might forget)

@ANeumann82
Copy link
Member Author

@alenkacz Yes, there are a couple points:

  1. I don't think the names of the files are (descriptive) enough.
  2. We have different types of KEP, I can think of at least "dev process", "future features" and "implemented and done". Having to look through all of them keeps getting harder, especially if we get into > 50 KEPs or so
  3. At the moment, it's kind of hard to get an overview what's there, in what state is it, etc.

And yes, I agree, having an additional file that needs to be updated isn't the best solution. It might work for now, and I don't think it has to be in sync all the time.

Alternatives would be:

  • Add some additional metadata to the KEPs itself (One-Line-Summary, Category) and write some tooling that autogenerates the README.md (or generate it in the www-project?). It still would need to be run either manually, or whenever something in the keps-folder changes. (Could that be done with github actions)?

Copy link
Member

@nfnt nfnt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Though, this should be automated at some point. The metadata you mention is already there, e.g. kep-number, title and status. I'm okay with writing this manually for now.

@ANeumann82 ANeumann82 requested a review from nfnt November 28, 2019 13:13
@ANeumann82
Copy link
Member Author

I've added a script to generate it, and added a "short-desc" field to the metadata for each KEP, as I think the title alone isn't expressive enough.

Copy link
Contributor

@alenkacz alenkacz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add information about the script to the keps/readme.md? Otherwise LGTM

Made script runnable from any directory
Copy link
Member

@nfnt nfnt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@ANeumann82 ANeumann82 merged commit 06c92b7 into master Nov 28, 2019
@ANeumann82 ANeumann82 deleted the an/kep-overview branch November 28, 2019 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants