-
Notifications
You must be signed in to change notification settings - Fork 15.4k
Content Guide: Revisit wording around adding content relating to CNCF, kubernetes, kubernetes-sigs projects with their own documentation #16143
Description
This is a Feature Request
Questions have arisen over where to put content if the content is about a kubernetes, kubernetes-sigs, or CNCF project if that project does have its own docs repo BUT the desired content does not exist in the external project's documentation.
I noticed that Split Falco audit into its own page (Issue #15963, PR #16011) was merged, and after chatting to @sftim, realized he and I interpreted the Content Guide differently.
Example:
Falco is a CNCF project. Falco has its own documentation.
Content about using Falco to collect audit events had been part of the Tasks/Monitoring, Logging, and Debugging/Auditing page. The Issue and subsequent PR moved the Falco section to its own page (Auditing with Falco). Note: the Auditing page also contains sections on how to use CNCF project fluentd to collect audit events as well as vendor-specific project logstash to collect audit events.
As Tim pointed out, the Falco content:
- ...falls between two stools: it's about Falco and about Kubernetes
- It's about doing a Kubernetes thing (cluster audit) using a CNCF project to help with that.
Using Falco to collect Kubernetes audit events is not covered in the Falco docs, so Tim looked at “Adding content for kubernetes or kubernetes-sigs projects that don't have their own instructional content” from the Content Guide section What is and isn't allowed and gave a LGTM to the PR.
My interpretation of the Content Guide is much more draconian: Since Falco is a CNCF project that has its own docs, put the Auditing with Falco content in the Falco docs and then link to it from the Kubernetes docs. Then the Falco project team doesn't have to think about testing and updating Falco-related content in the Kubernetes documentation with each new release of both Falco and Kubernetes.
After reading the Content Guide again, I noticed some issues, in bold:
Dual-sourced content
Is the content about an active CNCF project OR a project in the kubernetes or kubernetes-sigs GitHub organizations?
- If yes, then:
- Does the project have its own documentation?
- if yes, link to the project’s documentation from the Kubernetes documentation
- if no, add the content to the project’s repository if possible and then link to it from the Kubernetes documentation
- Does the project have its own documentation?
- Bullet point 1, Instructional content involving non-Kubernetes projects during setup or operation of Kubernetes,
- Allowed, second bullet point Adding content for kubernetes or kubernetes-sigs projects that don’t have their own instructional content
- Not Allowed, third bullet point Adding a tutorial on how to use a CNCF project or a project in the kubernetes or kubnetes-sigs GitHub organizations if the project has its own documentation
What Needs to be Clarified
If the content is about a CNCF, kubernetes, or kubernetes-sigs project that has its own documentation BUT the proposed content about performing a task in Kubernetes using the project does not exist in that project's docs:
- should we allow the content to be added to the Kubernetes documentation?
- should we not allow the content to be added to the Kubernetes documentation? Rather, state that the content should be added to the non-Kubernetes project's documentation and then link to that documentation from the Kubernetes documentation.
Action Items
- Obtain consensus from SIG Docs at the next meeting
- Update the Content Guide accordingly