-
Notifications
You must be signed in to change notification settings - Fork 103
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
KEP Overview #1110
Conversation
There was a problem hiding this 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)
@alenkacz Yes, there are a couple points:
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:
|
There was a problem hiding this 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.
Finish overview generator
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. |
There was a problem hiding this 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
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.