-
Notifications
You must be signed in to change notification settings - Fork 2
docs: update doc content #742
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
Changes from all commits
70b7f78
243ce84
a25993d
ac7a5cd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,7 @@ The Devsy team maintains providers for popular services such as: | |
| - [Azure (azure)](https://github.com/devsy-org/devsy-provider-azure) | ||
| - [Digital Ocean (digitalocean)](https://github.com/devsy-org/devsy-provider-digitalocean) | ||
|
|
||
| These providers can be installed with the Devsy CLI in the following form: | ||
| Install these providers with the Devsy CLI: | ||
| ``` | ||
| devsy provider add docker | ||
| ``` | ||
|
|
@@ -25,7 +25,7 @@ You can get a list of available 1st party providers by using the command: | |
| devsy provider list --available | ||
| ``` | ||
|
|
||
| ## Via Devsy Desktop Application | ||
| ## Devsy Desktop | ||
|
|
||
| Open the Providers view and click **Add**. The provider wizard has four steps: | ||
|
|
||
|
|
@@ -40,15 +40,15 @@ The ProviderSheet (click any provider in the list) exposes edit settings, switch | |
| The Desktop Application calls `devsy provider add PROVIDER` under the hood. | ||
| ::: | ||
|
|
||
| ### Adding a custom provider | ||
| ### Custom Providers | ||
|
|
||
| In the Select step, type one of the following into the **Provider Source** field below the preset grid: | ||
|
|
||
| - A GitHub link to the provider's project | ||
| - A URL to a `provider.yaml` | ||
| - A file path to a `provider.yaml` | ||
|
|
||
| ## Via Devsy CLI | ||
| ## Devsy CLI | ||
| Install any provider from the list with: | ||
|
|
||
| ```sh | ||
|
|
@@ -100,17 +100,16 @@ devsy provider add https://github.com/devsy-org/devsy-provider-ssh/releases/down | |
|
|
||
| ## Set Provider Options | ||
|
|
||
| Each provider has a set of options, those options can be different for each of | ||
| them, as they are defined by the provider's developers. | ||
| Each provider defines its own options, so they differ from provider to provider. | ||
|
|
||
| ### Managing options from Devsy Desktop Application | ||
| ### Desktop Options | ||
|
|
||
| To manage options from the app, head over the `Providers` section, and click | ||
| `Edit` on the provider you want to configure. | ||
|
Comment on lines
107
to
108
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Add the missing preposition. Change “head over the 🤖 Prompt for AI Agents |
||
|
|
||
| ### Managing options from Devsy CLI | ||
| ### CLI Options | ||
|
|
||
| Options for providers can be set during the `configure` or `add` phase: | ||
| Set options during the `add` or `configure` phase: | ||
|
|
||
| ```sh | ||
| devsy provider add <provider-name> -o KEY=value | ||
|
|
@@ -123,8 +122,7 @@ devsy provider init <provider-name> -o KEY=value | |
| ``` | ||
|
|
||
|
|
||
| Else, to can manage options afterwards from CLI, you can list the table of provider's options by using: | ||
|
|
||
| To manage options later, list the current values with: | ||
|
|
||
| ```sh | ||
| devsy provider get <provider-name> | ||
|
|
@@ -156,43 +154,19 @@ INJECT_GIT_CREDENTIALS | false | If Devsy should inject git | true | |
| | | host. | | | ||
| ``` | ||
|
|
||
| You can see this table as an overview, you can change each option using: | ||
| This table is an overview. Change any option with: | ||
|
|
||
| ```sh | ||
| devsy provider set <provider-name> --option <KEY>=<VALUE> | ||
| ``` | ||
|
|
||
| So for example, to change the default disk size from 40gb to 120gb, you could use: | ||
| For example, to change the disk size from 40GB to 120GB: | ||
|
|
||
| ```sh | ||
| devsy provider set aws --option AWS_DISK_SIZE=120 | ||
| ``` | ||
|
|
||
| And check again the options for the provider using `devsy provider get aws`: | ||
|
|
||
| ``` | ||
| NAME | REQUIRED | DESCRIPTION | DEFAULT | VALUE | ||
| ----------------------------+----------+--------------------------------+-------------------------+-------------------------- | ||
| AGENT_PATH | false | The path where to inject the | /var/lib/toolbox/devsy | /var/lib/toolbox/devsy | ||
| | | Devsy agent to. | | | ||
| AWS_ACCESS_KEY_ID | false | The aws access key id | | | ||
| AWS_AMI | false | The disk image to use. | | | ||
| AWS_DISK_SIZE | false | The disk size to use. | 40 | 120 | ||
| AWS_INSTANCE_TYPE | false | The machine type to use. | c5.xlarge | c5.xlarge | ||
| AWS_REGION | true | The aws cloud region to create | | us-west-2 | ||
| | | the VM in, e.g. us-west-1 | | | ||
| AWS_SECRET_ACCESS_KEY | false | The aws secret access key | | | ||
| AWS_VPC_ID | false | The vpc id to use. | | | ||
| INACTIVITY_TIMEOUT | false | If defined, will automatically | 10m | 10m | ||
| | | stop the VM after the | | | ||
| | | inactivity period. | | | ||
| INJECT_DOCKER_CREDENTIALS | false | If Devsy should inject docker | true | true | ||
| | | credentials into the remote | | | ||
| | | host. | | | ||
| INJECT_GIT_CREDENTIALS | false | If Devsy should inject git | true | true | ||
| | | credentials into the remote | | | ||
| | | host. | | | ||
| ``` | ||
| Run `devsy provider get aws` again to confirm — the `VALUE` column for `AWS_DISK_SIZE` now reads `120`. | ||
|
|
||
| ## Single Machine Provider | ||
|
|
||
|
|
@@ -210,9 +184,7 @@ devsy provider init <provider-name> --single-machine | |
|
|
||
| ## Default Provider | ||
|
|
||
| When adding a provider to Devsy, you can specify it to be the **default provider**, | ||
| this implies that when you create a Workspace, this provider will be used if no | ||
| other is specified. | ||
| When you add a provider, you can mark it as the **default provider**. Devsy then uses it for any workspace you create without specifying another. | ||
|
|
||
| In **the desktop app**, you can set a provider to be default in the option management interface for the provider | ||
| (see section above) | ||
|
|
@@ -238,7 +210,7 @@ The community maintains providers for additional services. | |
| - [Vultr (navaneeth-dev/devsy-provider-vultr)](https://github.com/navaneeth-dev/devsy-provider-vultr) | ||
| - [STACKIT (stackitcloud/devsy-provider-stackit)](https://github.com/stackitcloud/devsy-provider-stackit) | ||
|
|
||
| These providers can be installed with the Devsy CLI in the following form: | ||
| Install these providers with the Devsy CLI: | ||
| ``` | ||
| devsy provider add <user/repository> | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,17 +3,17 @@ title: Remove a Provider | |
| sidebar_label: Remove a Provider | ||
| --- | ||
|
|
||
| ## Via Devsy Desktop Application | ||
| ## Devsy Desktop | ||
|
|
||
| Navigate to the 'Providers' view and click on the trash icon of the provider | ||
| you want to remove. | ||
|
|
||
| If a workspace is currently using the provider, you'll be prompted to first | ||
| remove that workspace, in order to then remove the provider. | ||
|
Comment on lines
11
to
12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Tighten the removal sentence. Use “so you can then remove the provider” instead of “in order to then remove the provider.” 🧰 Tools🪛 LanguageTool[style] ~12-~12: Consider a more concise word here. (IN_ORDER_TO_PREMIUM) 🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
|
|
||
| ## Via Devsy CLI | ||
| ## Devsy CLI | ||
|
|
||
| An already installed provider can be removed by using: | ||
| Remove an installed provider with: | ||
|
|
||
| ```sh | ||
| devsy provider delete <provider name> | ||
|
|
||
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.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the approximately six-hour update interval.
“Every few hours” is ambiguous and does not implement the PR objective to correct the cadence to approximately six hours. Use explicit wording such as “about every six hours.”
Suggested wording
📝 Committable suggestion
🤖 Prompt for AI Agents