Skip to content
This repository was archived by the owner on Jan 8, 2025. It is now read-only.

Remove the ScopedBlock from the docs engine#382

Merged
ptgott merged 1 commit intomainfrom
paul.gottschling/116-no-scopedblock
Aug 24, 2023
Merged

Remove the ScopedBlock from the docs engine#382
ptgott merged 1 commit intomainfrom
paul.gottschling/116-no-scopedblock

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Aug 22, 2023

Fixes #116

We added the ScopedBlock component to the docs engine in order to give docs readers only the information they needed for their Teleport edition, without providing distracting details about other Teleport editions.

However, the vast majority of readers do not notice the scope switcher within the docs, meaning that any ScopedBlocks not assigned to the default scope (oss) go unseen. Removing the ScopedBlock will help us move toward a clearer information architecture that does not rely on scopes.

Fixes #116

We added the `ScopedBlock` component to the docs engine in order to give
docs readers only the information they needed for their Teleport
edition, without providing distracting details about other Teleport
editions.

However, the vast majority of readers do not notice the scope switcher
within the docs, meaning that any `ScopedBlock`s not assigned to the
default scope (`oss`) go unseen. Removing the `ScopedBlock` will help us
move toward a clearer information architecture that does not rely on
scopes.
@ptgott ptgott requested a review from avatus as a code owner August 22, 2023 16:51
@vercel
Copy link
Copy Markdown

vercel Bot commented Aug 22, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 22, 2023 8:23pm

@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Aug 22, 2023

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

H2 titles hidden by a ScopedBlock appear in a page's table of contents

2 participants