[#3409] improve(docs): Replace multi language tags with <Tabs groupId='language' queryString> #3861
Conversation
This file contains 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
LanceHsun
changed the title
|
Can you add pictures to show the preview effect of the document before and after the changes? |
jerryshao
changed the title
shaofengshi
pushed a commit
to shaofengshi/gravitino
that referenced
this pull request
Jun 24, 2024
…roupId='language' queryString> (apache#3861) ### What changes were proposed in this pull request? This pull request updates all `<Tabs>` components in the documentation to support multi-language switching by adding `groupId='language'` and `queryString` attributes. It also ensures that all related links in the documentation include the appropriate `queryString` parameter for language selection. Changes include: - Updating all `<Tabs>` components to the following format: ```markdown <Tabs groupId='language' queryString> <TabItem value="Json" label="Json"> ```json { "direction": "asc", "nullOrder": "NULLS_LAST", "sortTerm": { "type": "field", "fieldName": ["score"] } } ``` </TabItem> <TabItem value="java" label="Java"> ```java SortOrders.of(NamedReference.field("score"), SortDirection.ASCENDING, NullOrdering.NULLS_LAST); ``` </TabItem> </Tabs> **** ### Why are the changes needed? Fix: apache#3409 These changes are needed to enable multi-language support in the documentation, allowing users to easily switch between different language examples. This improves the usability and accessibility of the documentation for a wider audience. ### Does this PR introduce any user-facing change? Yes, this PR introduces the following user-facing changes: Users can now switch between different language examples in the documentation using a consistent interface. Documentation links will now include queryString parameters to ensure the correct language example is displayed. How was this patch tested? The changes were tested by: -Not yet Co-authored-by: LanceLin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
This pull request updates all
<Tabs>components in the documentation to support multi-language switching by addinggroupId='language'andqueryStringattributes. It also ensures that all related links in the documentation include the appropriatequeryStringparameter for language selection.Changes include:
<Tabs>components to the following format:Why are the changes needed?
Fix: #3409
These changes are needed to enable multi-language support in the documentation, allowing users to easily switch between different language examples. This improves the usability and accessibility of the documentation for a wider audience.
Does this PR introduce any user-facing change?
Yes, this PR introduces the following user-facing changes:
Users can now switch between different language examples in the documentation using a consistent interface.
Documentation links will now include queryString parameters to ensure the correct language example is displayed.
How was this patch tested?
The changes were tested by:
-Not yet