Replace multi-line ScopedBlocks with Tabs#30616
Merged
Conversation
Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change.
github-actions
Bot
requested review from
lsgunn-teleport,
r0mant,
xinding33 and
zmb3
Contributor
Author
|
TODO: I am going to backport this manually |
zmb3
approved these changes
Aug 17, 2023
lsgunn-teleport
approved these changes
Aug 17, 2023
Contributor
lsgunn-teleport
left a comment
lsgunn-teleport
left a comment
There was a problem hiding this comment.
for the sake of visibility in the near term.
public-teleport-github-review-bot
Bot
removed request for
r0mant and
xinding33
greedy52
reviewed
Aug 18, 2023
|
|
||
| </ScopedBlock> | ||
| </TabItem> | ||
| </Tabs> |
Contributor
There was a problem hiding this comment.
I don't think this end </Tabs> intended. Right?
Contributor
Author
There was a problem hiding this comment.
@greedy52 Thanks for catching this! I used a script to replace ScopedBlocks with Tabs components. I thought I caught all of the edge cases, but there are a couple remaining that I'll fix.
ptgott
added a commit
that referenced
this pull request
Aug 21, 2023
In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text.
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Aug 21, 2023
In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text.
ptgott
added a commit
that referenced
this pull request
Aug 21, 2023
Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616.
ptgott
added a commit
that referenced
this pull request
Aug 21, 2023
Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text.
ptgott
added a commit
that referenced
this pull request
Aug 21, 2023
Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616.
ptgott
added a commit
that referenced
this pull request
Aug 21, 2023
Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text.
This was referenced Aug 21, 2023
ptgott
added a commit
that referenced
this pull request
Aug 24, 2023
Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616.
ptgott
added a commit
that referenced
this pull request
Aug 24, 2023
Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text.
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Aug 24, 2023
* Replace multi-line ScopedBlocks with Tabs Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616. * Finish removing ScopedBlocks from the docs Backports #30629 Closes #30268 * Remove `Tabs` components with one `TabItem` Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text. * Remove the remaining ScopedBlocks in the docs * Remove the remaining ScopedBlocks
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Aug 24, 2023
* Replace multi-line ScopedBlocks with Tabs Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616. * Finish removing ScopedBlocks from the docs Backports #30629 Closes #30268 * Remove `Tabs` components with one `TabItem` Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text. * Remove the remaining ScopedBlocks in the docs
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Aug 24, 2023
* Replace multi-line ScopedBlocks with Tabs Backports #30616 * Replace multi-line ScopedBlocks with Tabs Contributes to #30268 The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes. While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually. Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change. * Remove more ScopedBlocks (#30623) This builds on the work done in #30616 and contributes to #30616. * Finish removing ScopedBlocks from the docs Backports #30629 Closes #30268 * Remove `Tabs` components with one `TabItem` Backports #30769 In #30616, we replaced `ScopedBlocks` with `Tabs` components. This was because most `ScopedBlocks` included variations on the same text for multiple scopes, and replacing them with `TabItem`s was straightforward. However, some replacements included only a single `TabItem`, which displays awkwardly in the docs. This change removes `Tabs` components with only one `TabItem`, replacing them with body text. * Remove the remaining ScopedBlocks in the docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributes to #30268
The documentation scope switcher tends to confuse users, and the ScopedBlock component hides docs content based on the scope switcher. To help remove ScopedBlocks from the docs site, this change replaces multi-line ScopedBlocks with Tabs components if they include variations for different scopes.
While most multi-line ScopedBlocks function like Tabs, there are a few edge cases, which this change addresses individually.
Note that this change does not intend to remove all ScopedBlocks that are placed inline within a paragraph. That will be the goal of a separate change.