Stream: cds hooks
Topic: Correct location for proposed hooks
Lloyd McKenzie (Aug 08 2018 at 14:19):
When looking for the wiki to propose new hooks, I found the following:
1. https://github.com/cds-hooks/docs/wiki/Proposed-Hooks
2. https://github.com/cds-hooks/docs/wiki (the little "Proposed Hooks" edit window that shows a small list of hooks that doesn't correspond to the previous link)
3. https://github.com/cds-hooks/cds-hooks/wiki/Proposed-Activities (it's archived, but there's nothing that indicates it's not authoritative or where the authoritative list is - it's also the first list I found when Googling)
4. https://github.com/cds-hooks/hooks/wiki (which says it's the repository for hooks, but is empty)
So which of these is "the" place to register proposed hooks? And can we get rid of the others (or at least include an indication that they're retired and point to the correct place)?
Kevin Shekleton (Aug 08 2018 at 15:34):
The cds-hooks/cds-hooks repository is the very first repository we were using but we moved away from it several years ago (which is why the repository is archived). If you look at the README in the repository, you'll see that note. Other than updating every single page to note this, I'm not sure what more we can do.
Kevin Shekleton (Aug 08 2018 at 15:36):
I hear your feedback though on this. We're actively working on shoring this all up now. See #195 :-)
Isaac Vetter (Aug 08 2018 at 15:36):
Lloyd, I'm actively working on defining and documenting the process for proposing/creating new hooks here: https://github.com/cds-hooks/docs/issues/195
Lloyd McKenzie (Aug 08 2018 at 17:21):
Can I wipe the little summary page on #2 that isn't actually a summary - or replace it with something that says "Quick Links" and includes a link to the actual proposed hooks page? Is the intention that we're going to migrate from #1 to #4? If not, can we delete #4? (Understand the issue with #3. If we make the correct link prominent enough elsewhere, it might not be a problem.)
Kevin Shekleton (Aug 08 2018 at 18:05):
https://github.com/cds-hooks/hooks/wiki was the working proposal for where proposed hooks would live
Kevin Shekleton (Aug 08 2018 at 18:06):
So yes, the intention was to migrate from https://github.com/cds-hooks/docs/wiki/Proposed-Hooks to https://github.com/cds-hooks/hooks/wiki. Though, I don't think we migrate that content over -- if people want to propose those hooks still, once we work out this process they can do so
Kevin Shekleton (Aug 08 2018 at 18:06):
What is the summary page on #2 that you are talking about wiping?
Lloyd McKenzie (Aug 08 2018 at 18:30):
Lloyd McKenzie (Aug 08 2018 at 18:31):
If we'll ask people to formally submit proposals, then we should update the Proposed-Hooks page to indicate that it's deprecated once it's deprecated - and wipe it after sufficient time has passed for people to migrate what they want to wipe.
Lloyd McKenzie (Aug 08 2018 at 18:33):
Given that the process is a little in flux, what's my best path for DaVinci hook proposals which I'd like to get up this week? Should I just define them in the IG and wait to submit? Put them on the Proposed-Hooks page for now? Act as guinea pig for the proposed new process? Some combination of the above? :)
Isaac Vetter (Aug 09 2018 at 02:34):
Hey @Lloyd McKenzie - the best case scenario (for CDS Hooks) is that you're the guinea pig for the proposed new process. I'd love your feedback. This is also probably the most expensive choice in terms of your time, though.
Lloyd McKenzie (Aug 09 2018 at 04:26):
Shall I tempt fate and say "How bad could it be?" ? :)
Lloyd McKenzie (Aug 09 2018 at 04:27):
Are we at the point where it would be appropriate to start crafting pull requests?
Isaac Vetter (Aug 09 2018 at 04:54):
Hey Lloyd, not really, but that shouldn't stop you.
I just jiggered around the hook maturity model in #195, but it's still a discussion or two (or three) from being incorporated into the spec.
The spirit of the process is that you should submit a PR for a new page, following the hook definition format and that PR should survive as the interim definition of the hook until maturity.
Last updated: Apr 12 2022 at 19:14 UTC
