docs icon indicating copy to clipboard operation
docs copied to clipboard

Add documentation for Serving probes

Open ReToCode opened this issue 1 year ago • 3 comments

Proposed Changes

  • Adds documentation for https://github.com/knative/serving/pull/14853

/assign @dprotaso /assign @skonto

ReToCode avatar Feb 08 '24 10:02 ReToCode

[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[bot] avatar Feb 08 '24 10:02 knative-prow[bot]

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
Latest commit bd831a116131e3b2c03a825a4f92167ef1439fc6
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.

netlify[bot] avatar Feb 08 '24 10:02 netlify[bot]

@dprotaso gentle ping.

ReToCode avatar Feb 13 '24 13:02 ReToCode

LGTM

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

skonto avatar Mar 13 '24 09:03 skonto

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?

ReToCode avatar Mar 13 '24 09:03 ReToCode

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?

skonto avatar Mar 13 '24 09:03 skonto

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.

ReToCode avatar Mar 14 '24 12:03 ReToCode

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.

skonto avatar Mar 26 '24 12:03 skonto

@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 avatar Apr 02 '24 07:04 ReToCode

/retest

ReToCode avatar Apr 02 '24 07:04 ReToCode

/lgtm

skonto avatar Apr 05 '24 07:04 skonto