Add custom footer to docs (#36)

GetDKAN · Oct 30, 2023 · e749ed0 · e749ed0
1 parent 5808f7e
commit e749ed0
Show file tree

Hide file tree

Showing 15 changed files with 50 additions and 35 deletions.
diff --git 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
diff --git 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
@@ -0,0 +1,2 @@
+<link rel="icon" href="{{ '/favicon.ico' | relative_url }}" type="image/x-icon">
+<link rel="shortcut icon" href="{{ '/favicon.png' | relative_url }}" type="image/png">
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
@@ -0,0 +1,12 @@
+<footer class="site-footer h-card">
+  <data class="u-url" href="{{ "/" | relative_url }}"></data>
+
+  <div class="wrapper">
+
+    <div class="social-links">
+      {%- include social.html -%}
+    </div>
+
+  </div>
+
+</footer>
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -0,0 +1,14 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  {%- seo -%}
+  <link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
+  {%- feed_meta -%}
+  {%- if jekyll.environment == 'production' and site.google_analytics -%}
+    {%- include google-analytics.html -%}
+  {%- endif -%}
+
+  {%- include custom-head.html -%}
+
+</head>
diff --git a/docs/_includes/social-icons/github.svg b/docs/_includes/social-icons/github.svg
diff --git 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
diff --git a/docs/favicon.png b/docs/favicon.png
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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.
  */