🔖 v1.0.0: Release commit (#175)

This commit includes documentation changes, screenshots, and updated
metadata for the UNICEF Inventory theme. These changes distinguish the
theme as its own independent theme from the original upstream theme, Dot
by Themefisher. It provides the needed metadata changes to the
`theme.toml` to support a profile on the official Hugo themes site.

The v1.0.0 git tag will correspond to this commit.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

README.md

@@ -1,84 +1,87 @@
-inventory-hugo-theme
-====================
+UNICEF Inventory theme
+======================
 
 <!--
     Style rule: one sentence per line please!
     This makes git diffs easier to read. :)
 -->
 
 UNICEF Inventory theme, for use with [Hugo](https://gohugo.io/) static site generator.
-Forked from Dot, a Hugo theme by ThemeFisher.
+A simple knowledge-base to share information with others.
 
 
-## Examples
+## :star2: Features
 
-* [UNICEF Open Source Inventory](https://unicef.github.io/inventory/)
-* [UNICEF Coach Cards](https://unicef.github.io/coach/)
-* [SustainOSS Design & UX knowledgebase](https://sustainers.github.io/design/)
-* Toolkits:
-    * [UNICEF Data Science & A.I. Toolkit](https://unicef.github.io/ooi-toolkit-ds/)
-    * [UNICEF Drones Toolkit](https://unicef.github.io/drone-4sdgtoolkit/)
-    * [UNICEF Software Development Toolkit](https://unicef.github.io/ooi-toolkit-software/)
+The UNICEF Inventory theme is designed to be a knowledge-base for thematic, indexed information.
+It was designed to meet a need for knowledge-transfer within the [UNICEF Office of Innovation](https://www.unicef.org/innovation/).
+The theme includes the following features:
 
+### General features
 
-## Installation
+Created with Bootstrap v4.
 
-The recommended installation method for an existing Hugo site is with a [git submodule](https://git-scm.com/docs/git-submodule).
-Use the commands below to add the theme to an existing Hugo site:
+* **Search bar with suggestions** to perform simple searches across all content
+* [**Brand and identity customization**](https://unicef.github.io/inventory-hugo-theme/features/brand-identity/) (colors, fonts, logos managed in config file)
+* **Frequently Asked Questions (F.A.Q.) shortcode** for a spoiler dropdown in any content
+* [**Admonitions**](https://unicef.github.io/inventory-hugo-theme/features/admonitions/) to call out specific information and details in an article
+* [**Author bylines**](https://unicef.github.io/inventory-hugo-theme/features/author-byline/) to identify the author of an article and optionally their contact information
+* **Responsive design** for a mobile-friendly navigation and user experience
+* **Multilingual support** (U.S. English, Spanish/español included; others possible)
+* **Google Analytics** support
+* **Contact form** (e.g. Formspree)
+* **OpenGraph tag** support (i.e. Twitter card metadata and other social media websites supported)
+* **Previous/Next buttons** in articles for sequentially-ordered content
+* [**Redirect post types**](https://unicef.github.io/inventory-hugo-theme/features/redirect/) to redirect the user to a URL hosted on an external website
 
-```bash
-cd /path/to/hugo-site/
-git submodule add [email protected]:unicef/inventory-hugo-theme.git themes/inventory
-git commit --signoff --message="Add UNICEF Inventory Hugo theme as a git submodule"
-git push
-```
+### UNICEF-specific features
 
-### Update a submodule to latest upstream
+* **Team Profiles** ([_example_](https://unicef.github.io/inventory/cohorts/)):
+  Create a special post for a [UNICEF Venture Fund](https://www.unicefinnovationfund.org/) start-up company with an open source product description and other metadata.
+* **DPG Standard indicators** ([_example_](https://unicef.github.io/inventory/dpg-indicators/)):
+  Use two nested categories to highlight each of the nine [Digital Public Goods Standard](https://digitalpublicgoods.net/standard/) indicators, provide more information about the indicator, and show site articles that describe the indicator.
 
-Sometimes you will want to update the git submodule with new changes added upstream to this repository.
-To pull newer upstream changes into your pre-existing git submodule, run the following from your Hugo project root directory:
 
-```bash
-git submodule update --remote --rebase
-```
+## Examples
 
+Browse other sites deployed using the UNICEF Inventory theme.
+If you use the theme in your Hugo site, please add your website to this README section as an example.
 
-## Configuration
+* [UNICEF Open Source Inventory](https://unicef.github.io/inventory/)
+* [SustainOSS Design & UX knowledgebase](https://sustainers.github.io/design/)
+* UNICEF Toolkits:
+    * [UNICEF Data Science & A.I. Toolkit](https://unicef.github.io/ooi-toolkit-ds/)
+    * [UNICEF Drones Toolkit](https://unicef.github.io/drone-4sdgtoolkit/)
+    * [UNICEF Software Development Toolkit](https://unicef.github.io/ooi-toolkit-software/)
 
-See [`exampleSite/config.yaml`](/exampleSite/config.yaml) for an example Hugo site using the UNICEF Inventory theme.
 
+## :electric_plug: Installation
 
-## :busts_in_silhouette: Contributing
+See the [installation guide](https://unicef.github.io/inventory-hugo-theme/install/new-site/).
+The guide provides recommended practices for deploying the UNICEF Inventory theme to GitHub Pages.
 
-See [`CONTRIBUTING.md`](/.github/CONTRIBUTING.md) for contribution guidelines, conventions and courtesies, and other advice for working on the UNICEF Inventory theme.
 
+## :nut_and_bolt: Configuration
 
-## Features
+See [`exampleSite/config.yaml`](https://github.com/unicef/inventory-hugo-theme/blob/main/exampleSite/config.yaml) for the example site configuration file.
 
-The upstream Dot theme includes the following features:
 
-- Support for translated content (English and Spanish built-in)
-- Google analytics support
-- CSS and Js bundle with hugo pipe
-- Color and fonts variable in config file
-- Contact form Support
-- Google page speed optimized ( 81% )
-- Open graph meta tag
-- Twitter card meta tag
-- Search suggestions
-- Powered by Bootstrap 4
-- Next/Prev buttons in single-post page
-- Frequently Asked Questions (F.A.Q.) page
-- Responsive-ready
+## :busts_in_silhouette: Contribute to the UNICEF Inventory theme
 
+<!-- TODO: Migrate to an article in the example site. -->
 
-## Share feedback
+See the UNICEF Inventory theme [`CONTRIBUTING.md`](https://github.com/unicef/inventory-hugo-theme/blob/main/.github/CONTRIBUTING.md) for contribution guidelines, conventions and courtesies, and help with setting up a developer environments.
 
-[Open a new issue to report bugs and request new features.](https://github.com/unicef/inventory-hugo-theme/issues/new/choose)
+
+## :speaking_head: Share your feedback
+
+Notice a bug or have an idea on how to improve the site?
+Consider [opening a user story](https://github.com/unicef/inventory-hugo-theme/issues/new?assignees=&labels=C%3A+design+thinking%2C%3F%3A+needs+triage&template=04-user-story.yml&title=As+a+%5Btype+of+user%5D%2C+I+want+%5Ban+action%5D+so+that+%5Ba+benefit%2Fa+value%5D.) or use [another GitHub Issue template](https://github.com/unicef/inventory-hugo-theme/issues/new/choose) to report bugs and request new features.
 
 
 ## :memo: Legal
 
+_Originally forked from [Dot](https://github.com/themefisher/dot-hugo), a Hugo theme by [ThemeFisher](https://themefisher.com/hugo-themes)_.
+
 Licensed under [MPL-2.0](https://www.mozilla.org/en-US/MPL/ "About the Mozilla Public License").
 From [_choosealicense.com_](https://choosealicense.com/licenses/mpl-2.0/):
 

config.yaml

@@ -0,0 +1,6 @@
+---
+module:
+  hugoVersion:
+    extended: false
+    max: ""
+    min: "0.64.0"

theme.toml

@@ -1,16 +1,41 @@
-# theme.toml template for a Hugo theme
-# See https://github.com/gohugoio/hugoThemes#themetoml for an example
+name = "UNICEF Inventory"
+license = "MPL-2.0"
+licenselink = "https://github.com/unicef/inventory-hugo-theme/blob/main/LICENSE.txt"
+description = "UNICEF Inventory theme, for use with Hugo. A simple knowledgebase to share information with others."
 
-name = "Dot"
-license = "MIT Licence"
-licenselink = "https://github.com/themefisher/dot/blob/master/LICENSE"
-description = "Dot, A documentation theme powered by hugo"
-homepage = "https://gethugothemes.com/products/hugo-documentation-theme/"
-demosite = "https://demo.gethugothemes.com/dot/"
-tags = ["documentation", "bootstrap", "light", "minimal", "clean", "simple", "fast", "modern", "white", "customizable", "creative", "flexbox","minimalistic","Highlight.js","typography", "docs", "material design", "highlighting", "contact form", "responsive", "Syntax highlighting", "Multilingual", "Single page", "Themefisher", "gethugothemes"]
-features = ["responsive","search autocomplete", "color scheme"]
-min_version = "0.64.0"
+# The home page of the theme, where the source can be found.
+homepage = "https://github.com/unicef/inventory-hugo-theme"
+
+# If you have a running demo of the theme.
+demosite = "https://unicef.github.io/inventory-hugo-theme/"
+
+tags = [
+    "bootstrap",
+    "customizable",
+    "contact form",
+    "docs",
+    "documentation",
+    "fast",
+    "flexbox",
+    "formspree",
+    "minimal",
+    "multilingual",
+    "responsive",
+    "simple"
+]
+
+features = [
+    "contact form",
+    "custom colors",
+    "multilingual",
+    "responsive",
+    "search"]
 
 [author]
-  name = "Themefisher"
-  homepage = "https://themefisher.com"
+    name = UNICEF Office of Innovation, Ventures Team"
+    homepage = "https://www.unicef.org/innovation/ventures"
+
+[original]
+    author = "Themefisher"
+    homepage = "https://themefisher.com"
+    repo = "https://github.com/themefisher/dot-hugo"