Skip to content
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

Potentially outdated documentation? #5736

Closed
yechuan51 opened this issue Oct 24, 2023 · 8 comments
Closed

Potentially outdated documentation? #5736

yechuan51 opened this issue Oct 24, 2023 · 8 comments
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@yechuan51
Copy link

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

@ReToCode
Copy link
Member

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?

@yechuan51
Copy link
Author

@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: knative/serving#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

@skonto
Copy link
Contributor

skonto commented Dec 1, 2023

Hi @yechuan51 here is the latest doc work merged: #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.

@yechuan51
Copy link
Author

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

@skonto
Copy link
Contributor

skonto commented Dec 13, 2023

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

@yechuan51
Copy link
Author

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

@skonto
Copy link
Contributor

skonto commented Feb 21, 2024

Hi @yechuan51 should we close this one?

Copy link

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 github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

3 participants