Skip to content

Commit

Permalink
[docs] Improve Acquia pull integration documentaion (#2936) [skip ci]…
Browse files Browse the repository at this point in the history
…[ci skip]
  • Loading branch information
tyler36 committed Apr 16, 2021
1 parent 28b801a commit 42db893
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions cmd/ddev/cmd/dotddev_assets/providers/acquia.yaml.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@
# 1. Get your Acquia API token from your Account Settings->API Tokens.
# 2. Make sure your ssh key is authorized on your Acquia account at Account Settings->SSH Keys
# 3. `ddev auth ssh` (this typically needs only be done once per ddev session, not every pull.)
# 4. Add add an entry to web_environment in ~/.ddev/global_config.yaml with the API keys:
# 4. Add / update the web_environment section in ~/.ddev/global_config.yaml with the API keys:
# ```yaml
# web_environment:
# - ACQUIA_API_KEY=xxxxxxxx
# - ACQUIA_API_SECRET=xxxxx
# ```
# 5. Copy acquia.yaml.example to acquia.yaml.
# 5. Copy .ddev/providers/acquia.yaml.example to .ddev/providers/acquia.yaml.
# 6. Update the project_id corresponding to the environment you want to work with.
# - If have acli install, you can use the following command: `acli remote:aliases:list`
# - Or, on the Acquia Cloud Platform navigate to the environments page, click on the header and look for the "SSH URL" line. Eg. `project1.dev@cool-projects.acquia-sites.com` would have a project ID of `project1.dev`
# 7. Your project must include drush; `ddev composer require drush/drush` if it isn't there already.
# 8. `ddev restart`
# 9. Use `ddev pull acquia` to pull the project database and files.
Expand Down
6 changes: 4 additions & 2 deletions docs/users/providers/acquia.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,18 @@ ddev's Acquia integration pulls database and files from an existing project into
1. Get your Acquia API token from your Account Settings->API Tokens.
2. Make sure your ssh key is authorized on your Acquia account at Account Settings->SSH Keys
3. `ddev auth ssh` (this typically needs only be done once per ddev session, not every pull.)
4. Add add an entry to web_environment in ~/.ddev/global_config.yaml with the API keys:
4. Add / update the web_environment section in ~/.ddev/global_config.yaml with the API keys:

```yaml
web_environment:
- ACQUIA_API_KEY=xxxxxxxx
- ACQUIA_API_SECRET=xxxxx
```

5. Copy acquia.yaml.example to acquia.yaml.
5. Copy .ddev/providers/acquia.yaml.example to .ddev/providers/acquia.yaml.
6. Update the project_id corresponding to the environment you want to work with.
- If have acli install, you can use the following command: `acli remote:aliases:list`
- Or, on the Acquia Cloud Platform navigate to the environments page, click on the header and look for the "SSH URL" line. Eg. `project1.dev@cool-projects.acquia-sites.com` would have a project ID of `project1.dev`
7. Your project must include drush; `ddev composer require drush/drush` if it isn't there already.
8. `ddev restart`
9. Use `ddev pull acquia` to pull the project database and files.
Expand Down

0 comments on commit 42db893

Please sign in to comment.