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.

Sign up for GitHub

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

Jump to bottom

Add section Deploy Local on Windows #3425

Merged
merged 3 commits into from
May 16, 2021
Merged

Add section Deploy Local on Windows #3425

merged 3 commits into from
May 16, 2021

Conversation

marcosmarxm
Copy link
Member

@marcosmarxm marcosmarxm commented May 14, 2021 •
edited by avaidyanatha
Loading

What

There is space to improve but this can help users to how install Docker on Windows

How

Describe the solution

Pre-merge Checklist

  • Run integration tests
  • Publish Docker images

Recommended reading order

  1. test.java
  2. component.ts
  3. the rest

Notes

Closes #1531

avaidyanatha
avaidyanatha approved these changes May 14, 2021
View reviewed changes
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.

Looks good, just some grammar edits.

docs/deploying-airbyte/local-deployment.md Outdated
@@ -18,6 +18,16 @@ docker-compose up
* In your browser, just visit [http://localhost:8000](http://localhost:8000)
* Start moving some data!

## Deploy on Windows

We recommend follow [this](https://docs.docker.com/docker-for-windows/install/) steps to install Docker on Windows.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
We recommend follow [this](https://docs.docker.com/docker-for-windows/install/) steps to install Docker on Windows.
We recommend following [this guide](https://docs.docker.com/docker-for-windows/install/) to install Docker on Windows.

docs/deploying-airbyte/local-deployment.md Outdated
## Deploy on Windows

We recommend follow [this](https://docs.docker.com/docker-for-windows/install/) steps to install Docker on Windows.
After installing WSL 2 backend and `docker` you should be able to run containers using Windows PowerShell.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After installing WSL 2 backend and `docker` you should be able to run containers using Windows PowerShell.
After installing the WSL 2 backend and Docker, you should be able to run containers using Windows PowerShell.

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

We recommend follow [this](https://docs.docker.com/docker-for-windows/install/) steps to install Docker on Windows.
After installing WSL 2 backend and `docker` you should be able to run containers using Windows PowerShell.
The steps on documentation suggested already install `docker-compose`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The steps on documentation suggested already install `docker-compose`.
Additionally, as we note frequently, you will need `docker-compose` to build Airbyte from source.

docs/deploying-airbyte/local-deployment.md Outdated
We recommend follow [this](https://docs.docker.com/docker-for-windows/install/) steps to install Docker on Windows.
After installing WSL 2 backend and `docker` you should be able to run containers using Windows PowerShell.
The steps on documentation suggested already install `docker-compose`.
If you don't have `git` installed in your machine you can download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you don't have `git` installed in your machine you can download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases).
Instead of cloning the repo, you can alternatively download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases).

docs/deploying-airbyte/local-deployment.md Outdated
After installing WSL 2 backend and `docker` you should be able to run containers using Windows PowerShell.
The steps on documentation suggested already install `docker-compose`.
If you don't have `git` installed in your machine you can download the latest Airbyte release [here](https://github.com/airbytehq/airbyte/releases).
Unzip the file downloaded, access the path you unzip the file using PowerShell terminal and run `docker-compose up`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Unzip the file downloaded, access the path you unzip the file using PowerShell terminal and run `docker-compose up`.
Unzip the downloaded file, access the unzipped file using PowerShell terminal, and run `docker-compose up`.

sherifnada
sherifnada approved these changes May 15, 2021
View reviewed changes
Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

agree w abhi's comments

@marcosmarxm
Copy link
Member Author

Thanks both!

@marcosmarxm marcosmarxm merged commit 18c1d6e into master May 16, 2021
@marcosmarxm marcosmarxm deleted the marcosmarxm/doc-deploy-windows branch May 16, 2021 22:44
htrueman added a commit that referenced this pull request May 18, 2021
@htrueman @davinchia
@yevhenii-ldv @vitaliizazmic @cgardens @avaidyanatha @jrhizor @vovavovavovavova @marcosmarxm @jamakase @masonwheeler @ChristopheDuong @sherifnada @michel-tricot
Source Iterable: update to use latest version of CDK (#3378)
588553e 
* Requirements updated to CDK.
airbyte-protocol and base-python requirements removed.

* Bugfix: BufferedStreamConsumer. (#3387)

* Format.

* Bump versions.

* main_dev.py renamed to main.py
README.md updated

* Source Stripe: Add Acceptance Tests to Stripe Connector (#3367)

* Add Acceptance Tests to Stripe Connector

* move configured_catalog.json to sample_files

* bump version

Co-authored-by: ykurochkin <y.kurochkin@zazmic.com>

* Legacy lib references removed

* FB Marketing source - lookback window logic not functioning correctly

* FB Marketing source #1390 - returning buffered record while incremental sync

* FB Marketing source #1390 - improving checking while syncing buffered record

* FB Marketing source #1390 - adding loop_back to IncrementalStreamAPI

* FB Marketing source #1390 - bump version

* FB Marketing source #1390 - add CHANGELOG.md

* Stop formatting python with spotless (#3388)

* add test that migration output schema same as source schema (#3356)

* Add updated architecture diagram to high level docs. (#3399)

* Add updated architecture doc to high level docs.

* Address review comments

Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local>

* Correct GA readme error. (#3407)

* make shopify more resilient to timeouts (#3409)

* Update migration schema to include recent changes to the StandardSync object. (#3414)

* Update all of Pydantic to 1.6.2 per Dependabot. (#3408)

* Update all to 1.6.2.

* Publish new airbyte-cdk version.

* Use repr instead of str for exceptions.

* Use rc.

* Edit test.

* Bump for SAT.

* Format.

* Docker ignore update. Fix setup.py

* fixing ONLY problematic fields in freshdesk JSON schemas (#3376)

* bump airbyte-webapp version (#2266)

* add configuration for bumping webapp versionn

* set to current version

* Bump version: 0.16.0-alpha → 0.16.1-alpha

* Revert "Bump version: 0.16.0-alpha → 0.16.1-alpha"

Thiss reverts commit fdbf6dc.

* also update package lock so we don't run into files changed errors

* use 0.19.0-alpha

* add npm webapp version

* Add a CDK speedrun tutorial doc (#3403)

* Add CDK Speedrun document.

* Finish speedrun doc.

* Address review comments

* Add to SUMMARY.md

Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local>

* Add Rust as a connector specific dependency to source-file (#3426)

* Add Rust as a connector specific dependency to source-file

* Add more details about installation.

* Markdown lines are weird.

Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local>

* API update to latest airbyte-cdk version

* Add section Deploy Local on Windows (#3425)

* add deploy on windows steps

* correct minor

* change suggestions by @avaidyanatha

* GitBook: [master] 161 pages and 75 assets modified

* Display icons (#3140)

* Display icons

* Improve icons views

* MS SQL Server Destination implementation

Fixes issue #613.

Normalization is not yet enabled.  This will have to be added at a later point.

* Workflow to handle operations (custom transformation) (#3379)

* Keep normalization backward compatible with old settings from destination

* Bumpversion normalization image

* add npm install before all npm run generates' (#3442)

* restart containers if they fail automatically (#3423)

* Update link for contribution scheduling (#3443)

* Address issue with icon in onboarding (#3437)

* rename toy connector tutorial to "Build a connector the hard way"  (#3421)

* Upload test reports (from integration test slash commands) as GitHub artifacts (#3416)

* Archive test reports in github workflow

* Archive Test reports only when failures

* Fixing SqlServerOperations.java (#3454)

Fixing some issues with `SqlServerOperations`, which was out of sync with recent changes to `SqlOperations`.

* Add redirect to cdk tutorial page (#3456)

* add redirect to cdk tutorial page

* change path to cdk README.md

Co-authored-by: Davin Chia <davinchia@gmail.com>
Co-authored-by: Yevhenii <34103125+yevhenii-ldv@users.noreply.github.com>
Co-authored-by: ykurochkin <y.kurochkin@zazmic.com>
Co-authored-by: vitaliizazmic <75620293+vitaliizazmic@users.noreply.github.com>
Co-authored-by: Charles <giardina.charles@gmail.com>
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local>
Co-authored-by: Jared Rhizor <jared@dataline.io>
Co-authored-by: vovavovavovavova <39351371+vovavovavovavova@users.noreply.github.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Marcos Marx <marcos@airbyte.io>
Co-authored-by: Artem Astapenko <3767150+Jamakase@users.noreply.github.com>
Co-authored-by: masonwheeler <masonwheeler@yahoo.com>
Co-authored-by: Christophe Duong <christophe.duong@gmail.com>
Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
Co-authored-by: Michel Tricot <michel@dataline.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@avaidyanatha avaidyanatha avaidyanatha approved these changes

@sherifnada sherifnada sherifnada approved these changes

@michel-tricot michel-tricot Awaiting requested review from michel-tricot

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the development process for Windows
3 participants
@marcosmarxm @sherifnada @avaidyanatha