diff --git a/.gitignore b/.gitignore index 6ca3c4e..5193c03 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,9 @@ .idea .vscode +docs/_site +docs/Gemfile +docs/Gemfile.lock + tests/bats tests/test_helper diff --git a/commands/doxygen/dkan-docs b/commands/doxygen/dkan-docs deleted file mode 100644 index 0a95997..0000000 --- a/commands/doxygen/dkan-docs +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash -#ddev-generated -## Description: Generate documentation for the DKAN module. -## -## Usage: dkan-docs [arguments] -## Flags: [] -## Example: "ddev dkan-docs" - -DOCS_PATH="modules/contrib/dkan" - -cd docroot/$DOCS_PATH -doxygen "$@" - -echo " * Documentation is now available at: $DDEV_PRIMARY_URL/$DOCS_PATH/docs/index.html" diff --git a/docs/_config.yml b/docs/_config.yml index 6c2e2bf..61f2ed0 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -4,6 +4,11 @@ header_pages: titles_from_headings: enabled: true strip_title: true +github_username: GetDKAN/ddev-dkan minima: social_links: - { platform: github, user_url: "https://github.com/getdkan/ddev-dkan" } +plugins: + - jekyll-seo-tag +sass: + quiet_deps: true diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html new file mode 100644 index 0000000..6911eca --- /dev/null +++ b/docs/_includes/custom-head.html @@ -0,0 +1,2 @@ + + diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html new file mode 100644 index 0000000..377f45f --- /dev/null +++ b/docs/_includes/footer.html @@ -0,0 +1,12 @@ + diff --git a/docs/_includes/head.html b/docs/_includes/head.html new file mode 100644 index 0000000..d788985 --- /dev/null +++ b/docs/_includes/head.html @@ -0,0 +1,14 @@ + + + + + {%- seo -%} + + {%- feed_meta -%} + {%- if jekyll.environment == 'production' and site.google_analytics -%} + {%- include google-analytics.html -%} + {%- endif -%} + + {%- include custom-head.html -%} + + diff --git a/docs/_includes/social-icons/github.svg b/docs/_includes/social-icons/github.svg new file mode 100644 index 0000000..9301f84 --- /dev/null +++ b/docs/_includes/social-icons/github.svg @@ -0,0 +1 @@ + diff --git a/docs/demo.md b/docs/demo.md index 5029a5d..59da0a5 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -1,16 +1,10 @@ -# Run The DKAN Demo Site +# Build a DKAN demo site -Note: As of DDEV 1.19.5, these instructions require managing the settings.php -file. After DDEV 1.19.6 is released, this will (hopefully) not be required. +The following commands will create a Drupal site with DKAN enabled and a sample react frontend for you to test out. mkdir my-project && cd my-project ddev config --auto - ddev get getdkan/dkan-ddev-addon + ddev get https://github.com/GetDKAN/ddev-dkan/archive/refs/heads/main.tar.gz ddev restart - ddev composer create getdkan/recommended-project:@dev -y - # At this point, we must add a configuration to settings.php - # This should change after DDev 1.19.6 is released. - 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 - ddev dkan-demo + ddev launch diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..8014e87 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/favicon.png b/docs/favicon.png new file mode 100644 index 0000000..0923e61 Binary files /dev/null and b/docs/favicon.png differ diff --git a/docs/getting-started.md b/docs/getting-started.md index 70e3ca8..564e1e2 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,7 +14,7 @@ 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. - ddev get https://github.com/GetDKAN/dkan-ddev-addon/archive/refs/heads/main.tar.gz + ddev get https://github.com/GetDKAN/ddev-dkan/archive/refs/heads/main.tar.gz Make sure we're using the addon. @@ -93,7 +93,3 @@ of DDEV. Run `ddev` by itself to get a list of commands available to you. Run `ddev get --list --all` to get a list of other DDEV add-ons. -## Additional Resources - -- [DDEV Documentation](https://ddev.readthedocs.io/en/stable/users/usage/) -- [DKAN Documentation](https://demo.getdkan.org/modules/contrib/dkan/docs/index.html) diff --git a/docs/index.md b/docs/index.md index dcaea1a..af66075 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,9 @@ 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. +- [DDEV Documentation](https://ddev.readthedocs.io/en/stable/users/usage/) +- [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 ask for help with any one of them with `ddev [command] --help` like this: @@ -24,9 +27,8 @@ ask for help with any one of them with `ddev [command] --help` like this: ## Sections: - [Getting started](getting-started.md) -- [Create a demo DKAN site](demo.md) +- [Build a DKAN demo site](demo.md) - [Convert a DKAN-Tools project to DDEV](dktl-convert.md) - [Testing the DKAN module](testing-dkan.md) -- [Debugging PHPUnit tests in DDev](testing-debug-phpunit.md) +- [Debugging PHPUnit tests in DDEV](testing-debug-phpunit.md) - [Testing your local development project](testing-project.md) -- [Generate DKAN Documentation](docs.md) diff --git a/install.yaml b/install.yaml index 573bdc8..13d61a7 100644 --- a/install.yaml +++ b/install.yaml @@ -52,7 +52,6 @@ pre_install_actions: project_files: - config.dkan.yaml - commands/cypress/cypress - - commands/doxygen/dkan-docs - commands/host/dkan-demo - commands/host/dkan-frontend-test-cypress - commands/host/dkan-init diff --git a/misc/settings.dkan-snippet.php.txt b/misc/settings.dkan-snippet.php.txt index e92412c..616413f 100644 --- a/misc/settings.dkan-snippet.php.txt +++ b/misc/settings.dkan-snippet.php.txt @@ -1,4 +1,4 @@ -// Automatically generated include for settings managed by dkan-ddev-addon. +// Automatically generated include for settings managed by ddev-dkan. // #ddev-generated if (file_exists(__DIR__ . '/settings.dkan.php') && getenv('IS_DDEV_PROJECT') == 'true') { include __DIR__ . '/settings.dkan.php'; diff --git a/misc/settings.dkan.php b/misc/settings.dkan.php index c7bdd47..d3e2ea9 100644 --- a/misc/settings.dkan.php +++ b/misc/settings.dkan.php @@ -2,7 +2,7 @@ /** * @file * #ddev-generated: Automatically generated Drupal settings file. - * DKAN-DDev-addon manages this file and may delete or overwrite the file unless this + * ddev-dkan manages this file and may delete or overwrite the file unless this * comment is removed. It is recommended that you leave this file alone. */