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

Add documentation for Serving probes #5855

Merged
merged 4 commits into from
Apr 5, 2024

Conversation

ReToCode
Copy link
Member

@ReToCode ReToCode commented Feb 8, 2024

Proposed Changes

/assign @dprotaso
/assign @skonto

Copy link

knative-prow bot commented Feb 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ReToCode

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot requested review from skonto and snneji February 8, 2024 10:08
@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 8, 2024
Copy link

netlify bot commented Feb 8, 2024

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bd831a1
🔍 Latest deploy log https://app.netlify.com/sites/knative/deploys/660bae18b7d6170008a85886
😎 Deploy Preview https://deploy-preview-5855--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 8, 2024
@ReToCode
Copy link
Member Author

@dprotaso gentle ping.

@skonto
Copy link
Contributor

skonto commented Mar 13, 2024

LGTM

A few suggestions. There is an opportunity to expand the whole section a bit with more info to educate users imho.

@knative-prow knative-prow bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 13, 2024
@skonto skonto removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 13, 2024
@ReToCode
Copy link
Member Author

It is an opportunity to expand the whole section a bit with more info to educate users imho.

Good point, I'll see what I can add without making it too complex here (e.g. not all internas are really relevant to the "casual" user). But we maybe can also link the FT document that has a whole table of combinations as well?

@skonto
Copy link
Contributor

skonto commented Mar 13, 2024

But we maybe can also link the FT document that has a whole table of combinations as well?

Do we do this elsewhere? I am afraid we might change the implementation without changing the ft doc (happened before) because ft doc has its own lifecycle. So I would say let's keep one place where info is updated and copy what makes sense from the ft doc. wdyth?

@ReToCode
Copy link
Member Author

I added more details in the docs. But I don't think this is the place to really put all the details about headers, how the components handle those and the exact rewriting. This documentation is focussing on the end-user and not Knative contributors. I think for those folks, the FTs + the actual code should be enough (at least it was for me working on this). An additional documentation is probably just going to be outdated at some point anyway.

@skonto
Copy link
Contributor

skonto commented Mar 26, 2024

Thanks @ReToCode for the updates some I added some minor comments. LGTM, I will wait @dprotaso for his review before merging or if he has no objection I can stamp it.

@ReToCode
Copy link
Member Author

ReToCode commented Apr 2, 2024

@skonto updated. I think we can go ahead without Dave here, as we can always update docs later on easily 👍 @dprotaso feel free to veto :)

@ReToCode
Copy link
Member Author

ReToCode commented Apr 2, 2024

/retest

@skonto
Copy link
Contributor

skonto commented Apr 5, 2024

/lgtm

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Apr 5, 2024
@knative-prow knative-prow bot merged commit bf326bb into knative:main Apr 5, 2024
19 checks passed
prushh pushed a commit to prushh/docs that referenced this pull request Apr 30, 2024
* Add documentation for probing

* Use white diagram background

* Add more details about probing

* Review improvements
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants