search

knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.41k stars 1.22k forks source link

Improve Serving encryption docs #5955

Closed ReToCode closed 1 month ago

ReToCode commented 2 months ago

Addressing https://github.com/knative/docs/pull/5804#discussion_r1584701059

ReToCode commented 2 months ago

/assign @rhuss

netlify[bot] commented 2 months ago

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
Latest commit a7231cfdd6292b4889b5921b3cfe06e65211af71
Latest deploy log https://app.netlify.com/sites/knative/deploys/663874f3ad7ae20008db478d
Deploy Preview https://deploy-preview-5955--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[bot] commented 2 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ReToCode, rhuss

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: - ~~[docs/serving/OWNERS](https://github.com/knative/docs/blob/main/docs/serving/OWNERS)~~ [ReToCode] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
ReToCode commented 2 months ago

@rhuss I don't think it is supported with the config used here:

image

Checked with and without the #.

ReToCode commented 1 month ago

/unhold

@rhuss PTAL

rhuss commented 1 month ago

@ReToCode even it is not rendered a callouts, the comment syntax in https://github.com/knative/docs/pull/5955#pullrequestreview-2035826549 should stimm work as it is valid YAML commenting.

My issue was, that if you add a very long trailing comment at the end of line, it leads to horizontal scrolling in the rendered web pages which is always annoying. So I would at leat put the comment above the line and make it maybe a multi-line comment if it is too long.

As this is "just" a usability issue, its fine for me as mentioned (I still add a /hold so you might still be able to adapt this (or not :)

/hold /lgtm

ReToCode commented 1 month ago

/unhold

Let's revisit this as a separate topic. If we do that, we should probably do it as a general pattern :)