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

Polish docs for installing airbyte on Plural #9461

Merged
merged 2 commits into from
Jan 13, 2022
Merged

Polish docs for installing airbyte on Plural #9461

merged 2 commits into from
Jan 13, 2022

Conversation

michaeljguarino
Copy link
Contributor

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@CLAassistant
Copy link

CLAassistant commented Jan 13, 2022

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Jan 13, 2022
@avaidyanatha avaidyanatha self-requested a review January 13, 2022 01:02
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.

Nice, looks good. Can we also add a ## Troubleshooting section? After that and addressing the final section, this looks good to go!

@@ -6,8 +6,9 @@ Plural is a unified application deployment platform that makes it easy to run op

## Getting Started

First, install Plural and the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your
application will be deployed to.
First, be sure to create an account on https://app.plural.sh. This is simply to track your installations and allow for the delivery of automated upgrades, you do not need to provide any infrastructure credentials or sensitive information.
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
First, be sure to create an account on https://app.plural.sh. This is simply to track your installations and allow for the delivery of automated upgrades, you do not need to provide any infrastructure credentials or sensitive information.
First, create an account on https://app.plural.sh. This is simply to track your installations and allow for the delivery of automated upgrades; you will not be asked to provide any infrastructure credentials or sensitive information.

application will be deployed to.
First, be sure to create an account on https://app.plural.sh. This is simply to track your installations and allow for the delivery of automated upgrades, you do not need to provide any infrastructure credentials or sensitive information.

Then install the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your application will be deployed to.
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
Then install the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your application will be deployed to.
Then, install the Plural CLI by following steps 1, 2, and 3 of the instructions [here](https://docs.plural.sh/getting-started). Through this, you will also configure your cloud provider and the domain name under which your application will be deployed to.

@@ -25,19 +26,35 @@ To install Airbyte on your Plural repo, simply run:
plural bundle install airbyte airbyte-aws
```

Plural's airbyte distribution currently has support for AWS, GCP and Azure set up and ready to go, feel free to pick whichever best fits your infrastructure.
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
Plural's airbyte distribution currently has support for AWS, GCP and Azure set up and ready to go, feel free to pick whichever best fits your infrastructure.
Plural's Airbyte distribution currently has support for AWS, GCP, and Azure set up and ready to go, so feel free to pick whichever best fits your infrastructure.


## Adding the Plural Console

To make management of your installation as simple as possible, including scaling, receiving automated upgrades and getting out-of-the-box dashboarding and log aggregation, we definitely recommending also installing the plural console. This can be done using the exact same process as above:
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
To make management of your installation as simple as possible, including scaling, receiving automated upgrades and getting out-of-the-box dashboarding and log aggregation, we definitely recommending also installing the plural console. This can be done using the exact same process as above:
To make management of your installation as simple as possible, we recommend installing the Plural console. The Plural console provides resource scaling, automated upgrades, out-of-the-box dashboarding, and log aggregation. This can be done using the exact same process as above:


To monitor and manage your Airbyte installation, head over to the Plural control panel at console.YOUR_ORGANIZATION.onplural.sh.
To learn more about
Copy link
Contributor

Choose a reason for hiding this comment

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

I think something was missing here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants