refactor: Inline quick start guide configure components#19100
Merged
kodiakhq[bot] merged 4 commits intocloudquery:mainfrom Sep 5, 2024
Merged
refactor: Inline quick start guide configure components#19100kodiakhq[bot] merged 4 commits intocloudquery:mainfrom
kodiakhq[bot] merged 4 commits intocloudquery:mainfrom
Conversation
erezrokah
commented
Sep 5, 2024
| } | ||
| } | ||
|
|
||
| ## Configure Destination Plugin |
Member
Author
There was a problem hiding this comment.
So instead of something like
Where the only difference between operating systems is the import for configure-sync-command, I inlined everything into a single component.
The logic to handle multiple operating systems is via the SyncCommand component switch case
erezrokah
commented
Sep 5, 2024
|
|
||
| You can run the sync by specifying the directory with the configuration files or each file individually | ||
|
|
||
| <SyncCommand os={props.os} /> |
Member
Author
There was a problem hiding this comment.
This will show the correct version of the sync command per OS
marianogappa
approved these changes
Sep 5, 2024
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
3 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.
Summary
At the moment the quick start guide is split into many components making it harder to update it. This was done to support multiple operating systems via components composition. However we can use the same approach as in #19095 (a
switch/caseto handle the logic) instead.That allows us to have a single component with all the guide, making it easier to update