Workload ID: Restructure docs to be more value-first #47637
Conversation
|
🤖 Vercel preview here: https://docs-jmikoxn0k-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-5gce73z6h-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-c1fsy323m-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-hplr0qoj9-goteleport.vercel.app/docs/ver/preview |
github-actions
bot
requested review from
mmcallister,
ptgott,
r0mant,
xinding33 and
zmb3
| There's a whole host of benefits to adopting Teleport Workload Identity, but | ||
| here's some of the key ones: | ||
|
|
||
| - Eliminate the use of long-lived shared secrets within your infrastructure, and | ||
| reduce the risk of exfiltration and time spent by engineers creating and | ||
| rotating these secrets. | ||
| - Establish an out of the box universal form of identity for your workloads, | ||
| enabling your engineers to get on with building new services without needing | ||
| to think about how they'll authenticate. | ||
| - Converge on a first-class form of identity for your workloads, simplifying | ||
| infrastructure by reducing the number of different ways workloads authenticate. |
There was a problem hiding this comment.
I would shorten this introductory section by combining the list of benefits with the list of use cases (and choosing three bullets total). That way, we can move past the generalities more quickly and get to the substantive details about how Workload Identity works and what it means in Teleport.
Co-authored-by: Paul Gottschling <[email protected]>
strideynet
added
the
no-changelog
|
🤖 Vercel preview here: https://docs-1zflfb9ky-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-g0dkl9x3f-goteleport.vercel.app/docs/ver/preview |
public-teleport-github-review-bot
bot
removed request for
r0mant,
mmcallister,
zmb3 and
xinding33
|
🤖 Vercel preview here: https://docs-mh196c3qc-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-ckxg9i2xr-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-6mvj09ttl-goteleport.vercel.app/docs/ver/preview |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
strideynet
deleted the
strideynet/restructure-workload-id-introduction
branch
|
@strideynet See the table below for backport results.
|
* Add include for preview * Keep hacking on phraseology * post-run better writing * Add diagram and how it works * Add short benefits section * Fix image path * Update docs/pages/enroll-resources/workload-identity/spiffe.mdx Co-authored-by: Paul Gottschling <[email protected]> * Simplify spiffe docs * Clarify defintiions * Americanize Spelling * Try to fix email link * Remove accidental character --------- Co-authored-by: Paul Gottschling <[email protected]>
* Add include for preview * Keep hacking on phraseology * post-run better writing * Add diagram and how it works * Add short benefits section * Fix image path * Update docs/pages/enroll-resources/workload-identity/spiffe.mdx * Simplify spiffe docs * Clarify defintiions * Americanize Spelling * Try to fix email link * Remove accidental character --------- Co-authored-by: Paul Gottschling <[email protected]>
Since we don't have a general landing page for Workload ID on the main marketing site, I figured it made some sense to try and make the Workload Identity introduction on the docs focus a little more on the potential use-cases and value - rather than diving straight into the technical deep-end.