-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
[Doc] Fix links in preload sample #2722
Conversation
/assign @IronPan |
/assign @neuromage |
Good idea! One more thing to add, did you also add a step to update README in release playbook? I think it would be best if we can automate pinning to release commit. |
I think what I would like to do instead, is to automatically check whether the links work in READMEs. Because the link also contains other parts in addition to commit SHA that might subject to change, like the paramterized tfx oss sample in this PR. |
I agree the extra check of whether the link works is useful. |
Yes agree, but an out-dated one would be better than a broken one I guess? If MKP deployment gets upgraded on a regular basis, changes in README should be picked up in an acceptable cadence. |
If it's not too much effort, I'd like both constraints satisfied. Otherwise, I agree stale is better than broken. |
So I guess the question here is, how can we prevent accidentally breaking the link in the preload samples and docs. And I think we have the following options:
I think I agree to your point that 1 is not satisfying. Does 2 LGTY? That being said, this PR itself is just a quick fix to an issue we discovered today. I'm happy to drive option 2 if we decide to go that way and after I'm done we can detach the links with specific commit SHAs. |
/lgtm The best process is harder than I thought, after some reflection, this is what I came up with:
What do you think? |
That SGTM. Let me update this with some commit SHA and update the playbook as well. |
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: IronPan The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Use a fixed version instead of master.
This change is