Add link references which were removed with #16011 #16140
Conversation
Signed-off-by: David Schneider <[email protected]>
|
Welcome @dsbrng25b! |
k8s-ci-robot
added
cncf-cla: yes
|
/assign @kbhawkey |
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit a634bbc https://deploy-preview-16140--kubernetes-io-master-staging.netlify.com |
k8s-ci-robot
added
the
lgtm
|
hello @dsbrng25b. Thanks for this PR. Page Preview: |
| @@ -496,4 +496,16 @@ plugin which supports full-text search and analytics. | |||
|
|
|||
| Visit [Auditing with Falco](/docs/tasks/debug-application-cluster/falco) | |||
|
|
|||
| [kube-apiserver]: /docs/admin/kube-apiserver | |||
| [auditing-proposal]: https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/auditing.md | |||
There was a problem hiding this comment.
@dsbrng25b, would you add parens around each link, such as:
[kube-apiserver](/docs/admin/kube-apiserver)
kube-apiserver
I would suggest creating a generic intro sentence and placing the Auditing with Falco link with the other links, alphabetically, if possible. You could also make a list of links if you like.
There was a problem hiding this comment.
The parens were not the problem. The link references have to be in the same capture block. Now the links are visible again.
There was a problem hiding this comment.
- OK, good, these changes fix the links. Typically, the links are embedded in the text, which I think is preferred.
- I read through both pages. I think that a link to the Falco documentation, instead of a page demonstrating how to set up k8s and Falco for auditing, would be in line with the Content Guidelines. Perhaps this page could include a link to
https://falco.org/docs/event-sources/kubernetes-audit/.
There was a problem hiding this comment.
Let's get this in to fix the links and address the content issue in another PR. Thanks!
/approve
k8s-ci-robot
removed
the
lgtm
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
I know the main PR has already merged (#16011).... Falco has its own documentation. Even though this content doesn't exist in the Falco docs, it might be better located there and then linked to from the Kubernetes documentation. I know the Content Guide states that "...Adding content for kubernetes or kubernetes-sigs projects that don’t have their own instructional content" is allowed, so I need to reword and expand that sentence. The end-goal is to keep project documentation in the project's docs so the project's developers know about it and can update it with each release if needed, rather than their having to keep track of project documentation in two places (eg Falco docs and Kubernetes docs). |
|
This felt to me like something that falls between two stools: it's about Falco and it's about Kubernetes. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kbhawkey 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 |
k8s-ci-robot
added
the
approved
…tes#16140) * Add link references which were removed with kubernetes#16011 Signed-off-by: David Schneider <[email protected]> * Move link references into correct capture block
Fix #16139