Merge pull request #548 from digitalocean/asb/issues/547

apps: Improve docs around git vs. github (Closes: #547).
digitalocean · Jan 6, 2021 · db8c4c2 · db8c4c2
2 parents 8a91e3e + 19ed4cb
commit db8c4c2
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/docs/resources/app.md b/docs/resources/app.md
@@ -136,10 +136,10 @@ A `service` can contain:
 * `instance_size_slug` - The instance size to use for this component.
 * `instance_count` - The amount of instances that this component should be scaled to.
 * `http_port` - The internal port on which this service's run command will listen.
-* `git` - A Git repo to use as component's source. Only one of `git` and `github` may be set.
+* `git` - A Git repo to use as the component's source. The repository must be able to be cloned without authentication. Only one of `git` and `github` may be set.
  - `repo_clone_url` - The clone URL of the repo.
  - `branch` - The name of the branch to use.
-* `github` - A GitHub repo to use as component's source. Only one of `git` and `github` may be set.
+* `github` - A GitHub repo to use as the component's source. DigitalOcean App Platform must have [access to the repository](https://cloud.digitalocean.com/apps/github/install). Only one of `git` and `github` may be set.
  - `repo` - The name of the repo in the format `owner/repo`.
  - `branch` - The name of the branch to use.
  - `deploy_on_push` - Whether to automatically deploy new commits made to the repo.
@@ -168,10 +168,10 @@ A `worker` can contain:
 * `environment_slug` - An environment slug describing the type of this app.
 * `instance_size_slug` - The instance size to use for this component.
 * `instance_count` - The amount of instances that this component should be scaled to.
-* `git` - A Git repo to use as component's source. Only one of `git` and `github` may be set.
+* `git` - A Git repo to use as the component's source. The repository must be able to be cloned without authentication. Only one of `git` and `github` may be set.
  - `repo_clone_url` - The clone URL of the repo.
  - `branch` - The name of the branch to use.
-* `github` - A GitHub repo to use as component's source. Only one of `git` and `github` may be set.
+* `github` - A GitHub repo to use as the component's source. DigitalOcean App Platform must have [access to the repository](https://cloud.digitalocean.com/apps/github/install). Only one of `git` and `github` may be set.
  - `repo` - The name of the repo in the format `owner/repo`.
  - `branch` - The name of the branch to use.
  - `deploy_on_push` - Whether to automatically deploy new commits made to the repo.
@@ -191,10 +191,10 @@ A `static_site` can contain:
 * `output_dir` - An optional path to where the built assets will be located, relative to the build context. If not set, App Platform will automatically scan for these directory names: `_static`, `dist`, `public`.
 * `index_document` - The name of the index document to use when serving this static site.
 * `error_document` - The name of the error document to use when serving this static site*
-* `git` - A Git repo to use as component's source. Only one of `git` and `github` may be set.
+* `git` - A Git repo to use as the component's source. The repository must be able to be cloned without authentication. Only one of `git` and `github` may be set.
  - `repo_clone_url` - The clone URL of the repo.
  - `branch` - The name of the branch to use.
-* `github` - A GitHub repo to use as component's source. Only one of `git` and `github` may be set.
+* `github` - A GitHub repo to use as the component's source. DigitalOcean App Platform must have [access to the repository](https://cloud.digitalocean.com/apps/github/install). Only one of `git` and `github` may be set.
  - `repo` - The name of the repo in the format `owner/repo`.
  - `branch` - The name of the branch to use.
  - `deploy_on_push` - Whether to automatically deploy new commits made to the repo.