-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
same standard for all proposals #1929
same standard for all proposals #1929
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.
Thanks @camilamacedo86!
I think we should:
- Agree what the valid status states are and use those consistently (might need to capitalize or lowercase everything)
- Document these states in the README with a short description of each.
- Document expectations in the README about keeping proposals up-to-date and adding links when appropriate (doc links when complete, issues/PRs when in progress, deprecated, or removed, etc).
6d1a465
to
fac29f5
Compare
Hi @joelanford, all changes requested are done... could we move forward with as it is and close the Issue? |
/test e2e-aws-ansible |
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.
If we're going to add doctoc and suggest it in the template, I think we also need:
- A make target to make it easy to regenerate
- To ensure that the sanity test fails if doctoc is not properly regenerated.
Hi @joelanford, Regards:
It is a great idea. I tracked it in #1941 and assigned it to me. I will do it asap :-) but I do not think that it is a blocker for this PR WDYT? |
I'd rather not add the doctoc without the tooling to generate it, since we'd be asking anyone contributing to documents to figure the tooling out and manually fix things in the meantime. Can we remove the doctoc from this PR and add it when we add the tooling? |
4c17ada
to
7011013
Compare
fdbf3e8
to
141eecd
Compare
Hi @joelanford, All files are updated and the target was added in the makefile. However, to add in the sanity, will be required do a PR for ci prow repo first for the image used here have the nodejs installed (yum install nodejs). IMHO: The index is very helpful to check the docs and in fact, we are using doctoc in few of them already and has other ones where the index was added manually which makes very hard keep them maintained. Just have the possibility to update and add them automatically in POV is enough for now. Also, all indexes have a comment with the link for the lib used and the info that they are generated automatically and all is very easy and intuitive to get working. Please, feel free to review and let me know if we can move forward with or if you would like to change something. |
doc/proposals/TEMPLATE.md
Outdated
@@ -1,13 +1,22 @@ | |||
## <Title of Proposal> |
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.
We should discuss as a team, but I wonder if we should start following the openshift/enhancement template for all SDK proposals, and make that the standard going forward? We will likely be using that openshift/enhancement template for a large portion of our future proposals anyway, so perhaps its best if we use it across the board for consistency.
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 really agree with. really makes sense we try to adopt/use the openshift template.
7c7be32
to
eec3242
Compare
Hi @joelanford, I think it is ok to be merged now and it shows enough for we close #1910. We could here update the current status of the repo proposals WDYT? |
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.
One final comment about the TLS proposal status. LGTM once that's addressed. Great job @camilamacedo86!
661fdb3
to
30a43d3
Compare
bab80be
to
32c8158
Compare
7e0da1a
to
695f4a9
Compare
/test e2e-aws-ansible |
Description of the change:
Motivation for the change:
Closes: #1910