fix: Use per OS login command in quick start guide#19095
Merged
kodiakhq[bot] merged 2 commits intocloudquery:mainfrom Sep 5, 2024
Merged
fix: Use per OS login command in quick start guide#19095kodiakhq[bot] merged 2 commits intocloudquery:mainfrom
kodiakhq[bot] merged 2 commits intocloudquery:mainfrom
Conversation
erezrokah
commented
Sep 5, 2024
| import ConfigureSource from './_configure-source.mdx'; | ||
| import ConfigureAuthenticateProvider from './_configure-authenticate-provider.mdx'; | ||
| import ConfigureStartSyncing from './_configure-start-syncing.mdx'; | ||
| import ConfigureSyncCommandUnixPrecompiled from './_configure-sync-command-unix-precompiled.mdx'; |
Member
Author
There was a problem hiding this comment.
Unrelated fix to make this filename more clear
erezrokah
commented
Sep 5, 2024
| import ConfigureSource from './_configure-source.mdx'; | ||
| import ConfigureAuthenticateProvider from './_configure-authenticate-provider.mdx'; | ||
| import ConfigureStartSyncing from './_configure-start-syncing.mdx'; | ||
| import ConfigureSyncCommand from './_configure-sync-command.mdx'; |
Member
Author
There was a problem hiding this comment.
Unrelated fix to make this filename more clear
erezrokah
commented
Sep 5, 2024
| --- | ||
|
|
||
| import Intro from '../../../components/mdx/_intro.mdx' | ||
| import SignIn from '../../../components/mdx/_cloudquery_sign_in.mdx' |
Member
Author
There was a problem hiding this comment.
Unrelated fix to make this filename to have consistent casing like other files
erezrokah
commented
Sep 5, 2024
| --- | ||
|
|
||
| import Intro from '../../../components/mdx/_intro.mdx' | ||
| import SignIn from '../../../components/mdx/_cloudquery_sign_in.mdx' |
Member
Author
There was a problem hiding this comment.
Unrelated fix to make this filename to have consistent casing like other files
erezrokah
commented
Sep 5, 2024
| --- | ||
|
|
||
| import Intro from '../../../components/mdx/_intro.mdx' | ||
| import SignIn from '../../../components/mdx/_cloudquery_sign_in.mdx' |
Member
Author
There was a problem hiding this comment.
Unrelated fix to make this filename to have consistent casing like other files
erezrokah
commented
Sep 5, 2024
| ```bash | ||
| cloudquery login | ||
| ``` | ||
| <SignIn os={props.os} /> |
Member
Author
There was a problem hiding this comment.
This is the fix, pass the prop from each individual OS guide to the SignIn to render a different command
marianogappa
approved these changes
Sep 5, 2024
kodiakhq bot
pushed a commit
that referenced
this pull request
Sep 5, 2024
#### 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/case` to handle the logic) instead. That allows us to have a single component with all the guide, making it easier to update
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
In our quick start guides we tell users to run
cloudquery login. However we use the same command for all operating systems.cloudquery loginwon't work for Linux (unless added to the PATH) or WindowsThis PR fixes the issue by using
cloudquery loginon macOS,./cloudquery loginon Linux andcloudquery.exe loginon Windows. The fix is consistent with how we tell users to run a sync a bit below in the guide:macOS
Linux
Windows