Skip to content

Commit

Permalink
Update documentation for getting the add-on (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
janette authored Oct 31, 2023
1 parent e749ed0 commit fa04121
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following commands will create a Drupal site with DKAN enabled and a sample

mkdir my-project && cd my-project
ddev config --auto
ddev get https://github.com/GetDKAN/ddev-dkan/archive/refs/heads/main.tar.gz
ddev get getdkan/ddev-dkan
ddev restart
ddev dkan-demo
ddev launch
8 changes: 4 additions & 4 deletions docs/dktl-convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Use the web root information to configure DDEV:
cd your_project_root
ddev config --project-type drupal9 --docroot YOUR_WEBROOT_VALUE --create-docroot

This command will set up an initial state of configuration. We're going to override this with the dkan-ddev-addon in
This command will set up an initial state of configuration. We're going to override this with ddev-dkan in
the next step, but DDEV requires that we do this first.

### Get the DKAN DDEV addon.
### Get the DKAN DDEV add-on.

ddev get https://github.com/GetDKAN/dkan-ddev-addon/archive/refs/heads/main.tar.gz
ddev get getdkan/ddev-dkan
ddev restart

This will pull down some configuration and scripts. We must then restart the DDEV environment after this.
Expand Down Expand Up @@ -87,7 +87,7 @@ and much like the modules and themes above we should move it.

Let's state up-front that it's complicated here.

First of all, we'll follow the instructions for the DKAN DDEV addon, and add the DKAN-specific config to settings.php.
First of all, we'll follow the instructions for the DKAN DDEV add-on, and add the DKAN-specific config to settings.php.

cat .ddev/misc/settings.dkan-snippet.php.txt >> docroot/sites/default/settings.php
cp .ddev/misc/settings.dkan.php docroot/sites/default/settings.dkan.php
Expand Down
10 changes: 4 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ Give DDEV just enough configuration to get started.

ddev config --auto

Grab the DKAN addon to get helpful DKAN commands.
Note that eventually we'll be 'official' and you won't have
to install this from a tarball.
Grab the DKAN add-on to get helpful DKAN commands.

ddev get https://github.com/GetDKAN/ddev-dkan/archive/refs/heads/main.tar.gz
ddev get getdkan/ddev-dkan

Make sure we're using the addon.
Make sure we're using the add-on.

ddev restart

Expand Down Expand Up @@ -70,7 +68,7 @@ use that repo as the getdkan/dkan package.

## Decoupled Frontend app installation and build

DKAN can integrate with a JS/headless app. The DKAN DDEV addon has special
DKAN can integrate with a JS/headless app. The DKAN DDEV add-on has special
commands for dealing with this.

### Install
Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
title: "DDEV-DKAN add-on"
---

The DDEV-DKAN add-on provides configuration and specialized commands for dealing
with a DKAN Drupal project in the DDEV environment.
The DDEV-DKAN add-on provides configuration and specialized commands for developing and maintaining a DKAN Drupal project
in a containerized environment.

- [Docker Documentation](https://docs.docker.com/desktop/)
- [DDEV Documentation](https://ddev.readthedocs.io/en/stable/users/usage/)
- [Drupal Documentation](https://www.drupal.org/docs/getting-started/system-requirements)
- [DKAN Documentation](https://dkan.readthedocs.io/en/latest/index.html)

Note that all the DKAN commands which come with this addon have documentation built-in. At the command line, you can
Note that all the DKAN commands which come with this add-on have documentation built-in. At the command line, you can
ask for help with any one of them with `ddev [command] --help` like this:

$ ddev dkan-init --help
Expand Down
4 changes: 2 additions & 2 deletions docs/testing-debug-phpunit.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Debugging a PHPUnit test with DDEV

This documentation is specific to using the DKAN DDEV addon, but can be
This documentation is specific to using the DKAN DDEV add-on, but can be
generalized for many other use-cases.

Currently, we're only going to talk about using PHPStorm. Do you have
Expand Down Expand Up @@ -100,7 +100,7 @@ Now head back to the test runner configuration and paste that in for environment
If you jumped the gun and clicked 'Apply' and 'OK' at this point, and tried to run the tests, you might have some success
with the runner. However, you'd see a lot of test fails.

That's because for DKAN, we must create users on the Drupal site. The DKAN addon allows for this with this command:
That's because for DKAN, we must create users on the Drupal site. The DKAN add-on allows for this with this command:

ddev dkan-test-users

Expand Down
4 changes: 2 additions & 2 deletions docs/testing-dkan.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Now use ddev to build a site and then test it.

mkdir myproject && cd myproject
ddev config --auto
ddev get https://github.com/GetDKAN/dkan-ddev-addon/archive/refs/heads/main.tar.gz
ddev get getdkan/ddev-dkan
ddev restart
ddev dkan-init
ddev dkan-site-install
Expand All @@ -42,7 +42,7 @@ And you can substitute the local dev DKAN module in this scenario as well:

mkdir myproject && cd myproject
ddev config --auto
ddev get https://github.com/GetDKAN/dkan-ddev-addon/archive/refs/heads/main.tar.gz
ddev get getdkan/ddev-dkan
ddev restart
ddev dkan-init --moduledev
cd dkan
Expand Down

0 comments on commit fa04121

Please sign in to comment.