docs icon indicating copy to clipboard operation
docs copied to clipboard

Potentially outdated documentation?

Open yechuan51 opened this issue 2 years ago • 7 comments

What is changing? (Please include as many details as possible.)

I was reading the documentation and found this: https://knative.dev/docs/serving/convert-deployment-to-knative-service/#determine-if-your-workload-is-a-good-fit-for-knative

I think the point "Your workload uses only Secret and ConfigMap volumes." might be outdated? I see that there's support(through extensions) to support PVCs with KNative: https://knative.dev/docs/serving/configuration/feature-flags/#kubernetes-persistentvolumeclaim-pvc

So I find the two pieces of documentation kinda conflict each other. Is the first piece of documentation outdated?

How will this impact our users?

Causes confusion

In what release will this take happen (to the best of your knowledge)?

Ex. v0.2-v0.3

Context

Link to associated PRs or issues from other repos here.

Additional info

yechuan51 avatar Oct 24 '23 17:10 yechuan51

Hey @yechuan51,

That is a valid point. @skonto is working on finishing the PVC documentation. @skonto do you mind to also include a fix for this?

ReToCode avatar Oct 25 '23 05:10 ReToCode

@ReToCode Thanks Reto for the pointer. I looked into @skonto 's tracking issue with PVC and it appears that it hasn't reached beta yet: https://github.com/knative/serving/issues/12438

So I think it's probably to early to adopt the PVC extension in production, but I'd still love to see a note made to the documentation in question about the potential future support for PVC: https://knative.dev/docs/serving/convert-deployment-to-knative-service/#determine-if-your-workload-is-a-good-fit-for-knative

yechuan51 avatar Oct 26 '23 03:10 yechuan51

Hi @yechuan51 here is the latest doc work merged: https://github.com/knative/docs/pull/5651, pls take a look. I can certainly take a look to update the issue above or feel free to create a PR and I can review it. PVCs are stable and we need to make a call for GA, see pending discussion at the related issue.

skonto avatar Dec 01 '23 23:12 skonto

Great! Thank you @skonto for the information about PVC maturity.

yechuan51 avatar Dec 02 '23 06:12 yechuan51

@yechuan51 Did you by any chance take a look at the updated docs?

skonto avatar Dec 13 '23 14:12 skonto

@skonto Yep, I have yet to start adding PVC to my knative workflows but I think the document is very well written.

yechuan51 avatar Dec 19 '23 06:12 yechuan51

Hi @yechuan51 should we close this one?

skonto avatar Feb 21 '24 11:02 skonto

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] avatar May 22 '24 01:05 github-actions[bot]