-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Conversation
There was a problem hiding this 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!
docs/deploying-airbyte/on-plural.md
Outdated
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
docs/deploying-airbyte/on-plural.md
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
docs/deploying-airbyte/on-plural.md
Outdated
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
docs/deploying-airbyte/on-plural.md
Outdated
|
||
## 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
docs/deploying-airbyte/on-plural.md
Outdated
|
||
To monitor and manage your Airbyte installation, head over to the Plural control panel at console.YOUR_ORGANIZATION.onplural.sh. | ||
To learn more about |
There was a problem hiding this comment.
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?
What
Describe what the change is solving
It helps to add screenshots if it affects the frontend.
How
Describe the solution
Recommended reading order
x.java
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
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/SUMMARY.md
docs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampledocs/integrations/README.md
airbyte-integrations/builds.md
Airbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing./publish
command described hereUpdating a connector
Community member or Airbyter
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampleAirbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing./publish
command described hereConnector Generator
-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