documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Avoid duplicating the RBAC setup

Open mfpierre opened this issue 3 years ago • 4 comments

What does this PR do?

Avoid duplicating the RBAC setup

Motivation

Avoid forgetting or updating the wrong RBAC section

Additional Notes


Reviewer checklist

  • [ ] Review the changed files.
  • [ ] Review the URLs listed in the Preview section.
  • [ ] Check images for PII
  • [ ] Review any mentions of "Contact Datadog support" for internal support documentation.

mfpierre avatar Jul 29 '22 12:07 mfpierre

Preview links (active after the build_preview check completes)

Modified Files

  • https://docs-staging.datadoghq.com/mfpierre/avoid-doc-duplication/infrastructure/livecontainers/configuration

github-actions[bot] avatar Jul 29 '22 12:07 github-actions[bot]

hi @mfpierre! While I'm a big fan of deduplicating, I don't think this page is the best use-case. It'll create more confusion for users than is really ideal. However, to make the difference more clear, we could move the "Instructions for previous Agent and Cluster Agent versions" to a different page, maybe called "Legacy configuration" or something. What do you think?

cswatt avatar Jul 29 '22 17:07 cswatt

@cswatt thanks for the review, I'm open to any suggestion that would allow us to avoid maintaining twice the RBAC list as it's prone to errors, maybe we could keep it as it's today but use some kind of an embed/include mechanism? (didn't look further if it was possible)

mfpierre avatar Aug 01 '22 10:08 mfpierre

Created DOCS-3900 to track Cecilia's review.

urseberry avatar Aug 05 '22 18:08 urseberry

Closing in favor of https://github.com/DataDog/documentation/pull/15093/

cswatt avatar Aug 23 '22 20:08 cswatt