Skip to content

Commit

Permalink
Mention ScopedBlock in the UI reference (#11903)
Browse files Browse the repository at this point in the history
  • Loading branch information
ptgott authored Apr 15, 2022
1 parent 8c887bb commit cabfcdb
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/pages/contributing/documentation/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,36 @@ The `Figure` component can help with using images, figures, and diagrams:
</Figure>
```

## ScopedBlock

Use the `ScopedBlock` component if you want to render some Markdown only for
users of open source Teleport, Teleport Cloud, or Teleport Enterprise.

`ScopedBlock` has a single property, `scope`, that works the same as it does for
other components we use in the documentation. See our
[explanation](./reference.mdx#scopes) of how to use the `scope` property.

Use this instead of the `Tabs` component when:

- You want to conceal details that aren't relevant to the reader's scope.
- The components you use don't look presentable within a `TabItem`, e.g., you're
including a separate `Tabs` component for each scope.

Any Markdown and MDX components can be included within a `ScopedBlock`.

```jsx
<ScopedBlock scope={["oss", "enterprise"]}>

Here are some options for installing the Teleport Auth and Proxy Services on
your own infrastructure.

<Tabs>
{/* TabItems that vary between scopes */}
</Tabs>

</ScopedBlock>
```

## Videos
To embed a video in a docs page, use the `video` tag:
```html
Expand Down

0 comments on commit cabfcdb

Please sign in to comment.