📚More clarity added for Windows based Docker Desktop environments #4068

ppatali · 2021-06-12T12:36:40Z

Changes to updating-documentation.md and local-deployment.md

While cloning repo on Windows platform, one might get errors related to long filenames. Added additional details about this error and how to recover from it, by doing localized Git config changes rather than system-wide.
Removed the instruction to restart the machine as this is not found to be required

Changes to postgres-replication.md and airbyte-specification.md

Minor corrections to text

…loning

ppatali · 2021-06-12T13:03:38Z

In two places, I have used the following syntax ../ to link to sections in other folder pages. Hope this is correct.

"instruction [here](../deploying-airbyte/local-deployment.md#handling-long-filename-error)"
"follow the [guide](../deploying-airbyte/local-deployment.md)"

ppatali · 2021-06-13T07:38:08Z

I have few more updates to documentation, in another branch - f143e4c 024d513 6c351af 1a0a1a5 47c15d0

Let me know if I should create a new PR for those or push those commits to this PR #4068

marcosmarxm

Thanks @ppatali! Is it possible merge the other doc changes to this pull request? They're minor ones and we could validated in one review one.

This reverts commit bbd3b78.

…during cloning" This reverts commit 0b695ee.

… local folder

ppatali · 2021-06-14T04:21:06Z

@marcosmarxm I have cleaned things up and merge changes from both branches to this PR.

docs/integrations/destinations/local-json.md

# Conflicts: # docs/understanding-airbyte/basic-normalization.md

ppatali · 2021-06-14T17:59:45Z

@marcosmarxm Suggestion incorporated and merge conflict resolved.

avaidyanatha

Looks solid! Just have some clarity and grammar changes for you!

docs/contributing-to-airbyte/updating-documentation.md

docs/deploying-airbyte/local-deployment.md

docs/examples/postgres-replication.md

avaidyanatha · 2021-06-14T18:18:09Z

docs/integrations/destinations/local-csv.md

-3. Navigate to the replicated file directory you specified when you created the destination, using `cd /{Directory_Specified}`
-4. List files containing the replicated data using `ls`
-5. Execute `cat {filename}` to display the data in a particular file
+1. Navigate to the default local mount using `cd /tmp/airbyte_local`


List formatting got messed up here.

I am bit puzzled too about this. The reason I made this change is based on the suggestion here for ordered list. I thought of this change because on the main Airbyte Gitbook docs, the section gets rendered like a paragraph instead of order list.

With my change, where every line starts with "1.", the Github still renders properly, as below. Hoping Gitbook may also render properly once this change?

avaidyanatha · 2021-06-14T18:18:23Z

docs/integrations/destinations/local-json.md

-3. Navigate to the replicated file directory you specified when you created the destination, using `cd /{Directory_Specified}`
-4. List files containing the replicated data using `ls`
-5. Execute `cat {filename}` to display the data in a particular file
+1. Navigate to the default local mount using `cd /tmp/airbyte_local`


List formatting also got messed up here.

See the response to previous comment

docs/quickstart/set-up-a-connection.md

avaidyanatha

Soft-block until the changes are in, but this looks great overall, thanks for helping improve our docs :)

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

ppatali · 2021-06-15T05:29:16Z

@avaidyanatha Thanks for the review and suggestions. I have committed those.

ppatali · 2021-06-16T16:21:26Z

@avaidyanatha All your suggestions are incorporated and pushed as commits. Regarding the List formatting, I have commented inline about why I had to use that syntax. Please let me know if any more changes is needed.

marcosmarxm · 2021-06-16T17:14:38Z

thanks @ppatali 💯

ppatali · 2021-06-16T17:35:58Z

Looks like the List formatting is still an issue in Gitbook. This screen is after PR merge. May be, tomorrow, I will generate another PR reverting this specific change .

marcosmarxm · 2021-06-16T17:44:07Z

@ppatali dont worry i'm going to correct that.

ppatali · 2021-06-16T17:45:32Z

Thanks, it needs to be corrected in two files. Local json and CSV.

marcosmarxm · 2021-06-16T17:47:40Z

#4165 @ppatali already done 🎉

Additinal details about Windows specific long filename error during c…

0b695ee

…loning

github-actions bot added the area/documentation Improvements or additions to documentation label Jun 12, 2021

Corrected the path

bbd3b78

ppatali marked this pull request as ready for review June 12, 2021 12:59

marcosmarxm requested a review from avaidyanatha June 13, 2021 13:40

marcosmarxm approved these changes Jun 13, 2021

View reviewed changes

ppatali added 2 commits June 14, 2021 08:41

Revert "Corrected the path"

939d4b5

This reverts commit bbd3b78.

Revert "Additinal details about Windows specific long filename error …

1fa479b

…during cloning" This reverts commit 0b695ee.

github-actions bot removed the area/documentation Improvements or additions to documentation label Jun 14, 2021

ppatali added 5 commits June 14, 2021 09:17

Email is mandatory 'Specify your preferences', Link to docker inst guide

c441c26

Use relative paths while linking

9bd789e

Typo in Destination section

66314fb

On Windows, fixing long filename error during cloning

02cb60f

For Windows with WSL2 and Docker, clarify steps to locate destination…

244d1d3

… local folder

github-actions bot added the area/documentation Improvements or additions to documentation label Jun 14, 2021

marcosmarxm added the community_pr label Jun 14, 2021

marcosmarxm reviewed Jun 14, 2021

View reviewed changes

docs/integrations/destinations/local-json.md Outdated Show resolved Hide resolved

ppatali added 2 commits June 14, 2021 23:15

Merge branch 'master' into docs-update-001

af02738

# Conflicts: # docs/understanding-airbyte/basic-normalization.md

Link to locating local files on Windows

5c9a5f4

ppatali changed the title ~~📚More clarity for Windows specific long filename error when cloning~~ 📚More clarity added for Windows based Docker Desktop environments Jun 14, 2021

avaidyanatha reviewed Jun 14, 2021

View reviewed changes

avaidyanatha suggested changes Jun 14, 2021

View reviewed changes

ppatali and others added 4 commits June 15, 2021 10:40

Update docs/contributing-to-airbyte/updating-documentation.md

122167f

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

Update docs/quickstart/set-up-a-connection.md

2244b39

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

Update docs/examples/postgres-replication.md

4074dc9

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

Update docs/examples/postgres-replication.md

2ff1d67

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

ppatali and others added 3 commits June 15, 2021 10:48

Update docs/examples/postgres-replication.md

9c572f3

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

Update docs/deploying-airbyte/local-deployment.md

542cca8

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

Update docs/deploying-airbyte/local-deployment.md

484bf8f

Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>

marcosmarxm approved these changes Jun 16, 2021

View reviewed changes

marcosmarxm merged commit 0884fa7 into airbytehq:master Jun 16, 2021

📚More clarity added for Windows based Docker Desktop environments #4068

📚More clarity added for Windows based Docker Desktop environments #4068

Uh oh!

Conversation

ppatali commented Jun 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ppatali commented Jun 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ppatali commented Jun 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcosmarxm left a comment

Choose a reason for hiding this comment

Uh oh!

ppatali commented Jun 14, 2021

Uh oh!

Uh oh!

ppatali commented Jun 14, 2021

Uh oh!

avaidyanatha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

avaidyanatha Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

ppatali Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

avaidyanatha Jun 14, 2021

Choose a reason for hiding this comment

Uh oh!

ppatali Jun 15, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

avaidyanatha left a comment

Choose a reason for hiding this comment

Uh oh!

ppatali commented Jun 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ppatali commented Jun 16, 2021

Uh oh!

marcosmarxm commented Jun 16, 2021

Uh oh!

ppatali commented Jun 16, 2021

Uh oh!

marcosmarxm commented Jun 16, 2021

Uh oh!

ppatali commented Jun 16, 2021

Uh oh!

marcosmarxm commented Jun 16, 2021

Uh oh!

Uh oh!

ppatali commented Jun 12, 2021 •

edited

Loading

ppatali commented Jun 12, 2021 •

edited

Loading

ppatali commented Jun 13, 2021 •

edited

Loading

ppatali commented Jun 15, 2021 •

edited

Loading