Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating integrations destinations local files doccs #3910

Merged
merged 10 commits into from
Jun 8, 2021
Merged

updating integrations destinations local files doccs #3910

merged 10 commits into from
Jun 8, 2021

Conversation

jacqueskpoty
Copy link
Contributor

What

This change will help users to easily locate local JSON and local CSV files. The previous Docs at the following link :
https://docs.airbyte.io/integrations/destinations/local-json and
https://docs.airbyte.io/integrations/destinations/local-csv,
Explain how to customize the local directory that stores the replicated files and also states at the end that - " If Airbyte instance is running on the same computer that you are navigating with, you can open your browser to go to file:///tmp/airbyte_local and look at the replicated data locally "

However it does not state how to access the replicated files if you are running airbyte on a remote server or for some reason cant access the file by using the specified approach above (file:///tmp/airbyte_local)

So it's important to show the user how to get to those file though the shell command by accessing the not-so-obvious container which hosts them. In fact the container which hosts these files is the airbyte-scheduler which is not obvious at all. I'am an airbyte user and I thought those files were stored in the airbyte-server. Thus it's even important to let the user know how and where to get those local files at. Following is the change I made to the local JSON and local CSV docs:

I changed this

With this in both files
(If Airbyte instance is running on the same computer that you are navigating with, you can open your browser to go to file:///tmp/airbyte_local and look at the replicated data locally)

Access Replicated Data Files

  • If Airbyte instance is running on the same computer that you are navigating with, you can open your browser to go to file:///tmp/airbyte_local and look at the replicated data locally
  • If Airbyte instance is running on a remote server or for some reasons you can't use the first approach ([file:///tmp/airbyte_local]) to access the replicated files, follow the following steps to access the replicated files:
    • Access the scheduler container using docker exec -it airbyte-scheduler bash
    • Make sure you are at the root folder of the container using cd ..
    • Navigate to the default local mount using cd /tmp/airbyte_local
    • Navigate to the replicated file directory you specified when you created the destination, using cd /{Directory_Specified}
    • Now you can see all the files containing the replicated data using ls

docs/integrations/destinations/local-json.md Outdated Show resolved Hide resolved
docs/integrations/destinations/local-json.md Outdated Show resolved Hide resolved
Comment on lines 55 to 56
* Now you can see all the files containing the replicated data using `ls`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After that you could execute cat filename to get information from the file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marcosmarxm The change you suggested is good with me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I modified the two files and pushed them.

Copy link
Contributor

@avaidyanatha avaidyanatha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it, thank you for the contribution @jacqueskpoty! I just have some small clarity changes and this should be good to go.

docs/integrations/destinations/local-csv.md Outdated Show resolved Hide resolved
docs/integrations/destinations/local-csv.md Outdated Show resolved Hide resolved
docs/integrations/destinations/local-csv.md Outdated Show resolved Hide resolved
docs/integrations/destinations/local-csv.md Outdated Show resolved Hide resolved
jacqueskpoty and others added 5 commits June 7, 2021 12:53
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
@jacqueskpoty
Copy link
Contributor Author

I considered the suggested changes and pushed

Copy link
Contributor

@avaidyanatha avaidyanatha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for making the changes @jacqueskpoty!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants