WIP: Updated the theme and logo for docs website; slight improvements…

.readthedocs.yml

@@ -0,0 +1,16 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.8"
+
+mkdocs:
+ configuration: mkdocs.yml
+
+python:
+ install:
+ - requirements: docs/requirements.txt
+

docs/developer-guide/getting-started.md

@@ -1,18 +1,22 @@
 # Getting Started
 
+!!!danger
+ These developer instructions might be slightly outdated, so please use the instructions found on our main repository's README file.
+
 ## Dependencies
 
 ### Required
 * Java 7
-* MySQL 5.5+
-* [SDK Man] (http:https://sdkman.io/install.html)
+* MySQL 5.7+
+* [SDK Man](http:https://sdkman.io/install.html)
 * [Grails 1.3.9](http:https://grails.org/download/archive/Grails)
 * NPM
 
-NOTE: We are in the process of upgrading to Grails 2.5.5 [(see this feature branch).](https://github.com/openboxes/openboxes/tree/feature/94-upgrade-to-grails-2.5.x) Once that is complete you will be able to use Java 8. 
+!!! note
+ NOTE: We are in the process of migration the application from Grails 1.3.9 to Grails 3.3.10 [(see this feature branch).](https://github.com/openboxes/openboxes/tree/feature/upgrade-to-grails-3.3.10) Once that is complete you will be able to use Java 8. 
 
 ### Optional, but recommended
-* [IntelliJ IDEA] (https://www.jetbrains.com/idea/download/)
+* [IntelliJ IDEA](https://www.jetbrains.com/idea/download/)
 
 ## Instructions
 These instructions are for developers only. If you are a system administrator looking to install OpenBoxes on your

docs/overrides/partials/logo.html

@@ -0,0 +1,29 @@
+<!--
+ Copyright (c) 2016-2023 Martin Donath <[email protected]>
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to
+ deal in the Software without restriction, including without limitation the
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ sell copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ IN THE SOFTWARE.
+-->
+
+<!-- Logo -->
+{% if config.theme.logo %}
+ <img src="{{ config.theme.logo | url }}" alt="logo" />
+{% else %}
+ {% set icon = config.theme.icon.logo or "material/library" %}
+ {% include ".icons/" ~ icon ~ ".svg" %}
+{% endif %}

docs/requirements.txt

@@ -1,2 +1,4 @@
 mkdocs==1.2.3
 mkdocs-material
+mkdocs-material-extensions
+materialx

docs/stylesheets/extra.css

@@ -0,0 +1,3 @@
+.md-nav__title { color: purple; }
+
+.md-header__title { font-size: 21pt; }

docs/user-guide/index.md

@@ -1,34 +1,44 @@
 
-Please be patient as our documentation expert (a.k.a our lead developer) is busy making the software 
-not suck so he's had some trouble finding time to update these guides. 
+# Getting Started 
 
-## Contributing
-If you would like to contribute to this User Guide, please refer to the 
-[Contributing](../developer-guide/contributing.md) section in the Developer Guide 
-as well as the [CONTRIBUTING.md](https://github.com/openboxes/openboxes/blob/develop/CONTRIBUTING.md)
-docs in our GitHub repository.
+## Knowledge Base
 
-If you would prefer to submit documentation updates as Word docs or collaborate with us
-using Google Docs, please share the docs or links with our Support Team [[email protected]](mailto:[email protected]).
+Review our knowledge base for step-by-step instructions on the most common features. 
 
-If you're impatient, not good at words & stuff, and would prefer to see User Guide completed pronto, 
-please feel free to light a fire under our documentation expert. The most effective way to do that 
-would be to shame him through any of the public support channels (i.e. Twitter, Slack, Google 
-Groups, highway billboards, etc). 
+<a href="https://help.openboxes.com">
+![img.png](../img/helpscout.png){height:20%}
+</a>
 
 ## Discussion Forum
-Review our Community Forum for answers to common questions or to post your own question. 
-<https://discuss.openboxes.com/>
 
+Post your questions to our Community Forum and search for answers to common questions. 
+
+<a href="https://community.openboxes.com">
+![img.png](../img/discourse2.png)
+</a>
 
 ## YouTube channel
 Subscribe to our YouTube Channel! Or ... ya know ... don't. It's up to you.
 <a href="https://www.youtube.com/channel/UC-e9K2wU9wZFQ11eF-vwu6Q">
-![img.png](../img/youtube.png)
+![img.png](../img/youtube2.png)
 </a>
 
 ## Tutorials 
 Check out our tutorials page for the most up-to-date tutorials.
 <a href="https://openboxes.com/tutorials">
 ![img.png](../img/tutorials.png)
 </a>
+
+## Contributing
+If you would like to contribute to this User Guide, please refer to the 
+[Contributing](../developer-guide/contributing.md) section in the Developer Guide 
+as well as the [CONTRIBUTING.md](https://github.com/openboxes/openboxes/blob/develop/CONTRIBUTING.md)
+docs in our GitHub repository.
+
+If you would prefer to submit documentation updates as Word docs or collaborate with us
+using Google Docs, please share the docs or links with our Support Team [[email protected]](mailto:[email protected]).
+
+If you're impatient, not good at words & stuff, and would prefer to see User Guide completed pronto, 
+please feel free to light a fire under our documentation expert. The most effective way to do that 
+would be to shame him through any of the public support channels (i.e. Twitter, Slack, Google 
+Groups, highway billboards, etc). 

mkdocs.yml

@@ -5,16 +5,31 @@ site_url: https://docs.openboxes.com/en/
 repo_url: https://github.com/openboxes/openboxes
 theme:
  name: material
+ custom_dir: docs/overrides
  logo: img/logo.svg
  palette:
- primary: white
- accent: blue
+
+ # Palette toggle for light mode
+ - scheme: default
+ toggle:
+ icon: material/toggle-switch
+ name: Switch to dark mode
+
+ # Palette toggle for dark mode
+ - scheme: slate
+ toggle:
+ icon: material/toggle-switch-off-outline
+ name: Switch to light mode
+
  features:
  - navigation.tabs
- - toc.integration
 use_directory_urls: true
-copyright: Copyright © 2010-2021, OpenBoxes
-google_analytics: ['UA-37396941-2', 'openboxes.com']
+copyright: Copyright © 2010-2023, OpenBoxes
+extra:
+ stylesheet: stylesheets/extra.css
+ analytics:
+ provider: google
+ property: G-4244ZMRC67
 markdown_extensions:
  - attr_list
  - admonition
@@ -30,54 +45,56 @@ nav:
  - Benefits: about/benefits.md
  - Considerations: about/considerations.md
  - Release Notes: about/release-notes.md
- - Installation Guide:
- - Getting Started: installation/index.md
- - Installation:
- - Ubuntu:
- - Ubuntu 18.04:
- - Overview: installation/ubuntu1804/index.md
- - Requirements: installation/ubuntu1804/requirements.md
- - Hosting: installation/ubuntu1804/hosting.md
- - Ubuntu: installation/ubuntu1804/ubuntu.md
- - Java: installation/ubuntu1804/java.md
- - Tomcat: installation/ubuntu1804/tomcat.md
- - MySQL: installation/ubuntu1804/mysql.md
- - Apache: installation/ubuntu1804/apache.md
- - Configuration: installation/ubuntu1804/configuration.md
- - Deployment: installation/ubuntu1804/deployment.md
- - Troubleshooting: installation/ubuntu1804/troubleshooting.md
- - Ubuntu 18.04 (Grails v3):
- - Overview: installation/ubuntu1804-grails3/index.md
- - Hosting: installation/ubuntu1804-grails3/hosting.md
- - Ubuntu: installation/ubuntu1804-grails3/ubuntu.md
- - Java: installation/ubuntu1804-grails3/java.md
- - MySQL: installation/ubuntu1804-grails3/mysql.md
- - Application: installation/ubuntu1804-grails3/application.md
- - Apache/Nginx: installation/ubuntu1804-grails3/webserver.md
- - Deployment: installation/ubuntu1804-grails3/deployment.md
- - Configuration: installation/ubuntu1804-grails3/configuration.md
- - Troubleshooting: installation/ubuntu1804-grails3/troubleshooting.md
- - Ubuntu 16.04:
- - Instructions: installation/ubuntu1604.md
- - Notes: installation/ubuntu1604-notes.md
- - Ubuntu 14.04: installation/ubuntu1404.md
- - Advanced: installation/advanced.md
- - Docker: installation/docker.md
- - Mac OS: installation/macos.md
-  - Windows: installation/windows.md
+ - Installation:
+ - Overview: installation/index.md
+ - Instructions:
+  - Ubuntu:
+  - Ubuntu 18.04:
+  - Overview: installation/ubuntu1804/index.md
+  - Requirements: installation/ubuntu1804/requirements.md
+  - Hosting: installation/ubuntu1804/hosting.md
+  - Ubuntu: installation/ubuntu1804/ubuntu.md
+  - Java: installation/ubuntu1804/java.md
+  - Tomcat: installation/ubuntu1804/tomcat.md
+  - MySQL: installation/ubuntu1804/mysql.md
+  - Apache: installation/ubuntu1804/apache.md
+  - Configuration: installation/ubuntu1804/configuration.md
+  - Deployment: installation/ubuntu1804/deployment.md
+  - Troubleshooting: installation/ubuntu1804/troubleshooting.md
+  - Ubuntu 18.04 (Grails v3):
+  - Overview: installation/ubuntu1804-grails3/index.md
+  - Hosting: installation/ubuntu1804-grails3/hosting.md
+  - Ubuntu: installation/ubuntu1804-grails3/ubuntu.md
+  - Java: installation/ubuntu1804-grails3/java.md
+  - MySQL: installation/ubuntu1804-grails3/mysql.md
+  - Application: installation/ubuntu1804-grails3/application.md
+  - Apache/Nginx: installation/ubuntu1804-grails3/webserver.md
+  - Deployment: installation/ubuntu1804-grails3/deployment.md
+  - Configuration: installation/ubuntu1804-grails3/configuration.md
+  - Troubleshooting: installation/ubuntu1804-grails3/troubleshooting.md
+  - Ubuntu 16.04:
+  - Instructions: installation/ubuntu1604.md
+  - Notes: installation/ubuntu1604-notes.md
+  - Ubuntu 14.04: installation/ubuntu1404.md
+ - Docker: installation/docker.md
+  - Mac OS: installation/macos.md
+  - Windows: installation/windows.md
+ - Advanced: installation/advanced.md
  - Upgrading: upgrading/index.md
- - Configuration Guide:
+ - Configuration:
  - Overview: configuration/index.md
- - Tomcat AJP: configuration/ajp.md
- - Apache HTTPS: configuration/https.md
- - Database Connection: configuration/database.md
+ - Database: configuration/database.md
  - Email: configuration/email.md
  - OpenBoxes: configuration/application.md
  - Sentry: configuration/sentry.md
+ - Advanced:
+ - Tomcat AJP: configuration/ajp.md
+ - Apache HTTPS: configuration/https.md
  - Example: configuration/example.md
- - User Guide: user-guide/index.md
+ - Getting Started:
+ - Overview: user-guide/index.md
  - Developer Guide:
- - Introduction: developer-guide/index.md
+# - Introduction: developer-guide/index.md
  - Getting Started: developer-guide/getting-started.md
  - Contributing: developer-guide/contributing.md
  - Syncing a Fork: developer-guide/syncing-a-fork.md
@@ -97,24 +114,25 @@ nav:
  - Hotfix Lifecycle: developer-guide/hotfix/index.md
  - API Guide:
  - Overview: api-guide/index.md
- - Generic API: api-guide/generic.md
  - Getting Started: api-guide/getting-started.md
  - Searching: api-guide/lookup.md
- - Core:
- - Identifiers: api-guide/identifier.md
- - Internal Locations: api-guide/internalLocation.md
- - Localizations: api-guide/localization.md
- - Locations: api-guide/location.md
- - Reason Codes: api-guide/reasonCode.md
- - Products:
- - Categories: api-guide/category.md
- - Products: api-guide/product.md
- - Stock Movements:
- - Stock Movement: api-guide/stockMovement.md
- - Stock Movement Item: api-guide/stockMovementItem.md
- - Stock Movement Status: api-guide/stockMovementStatus.md
- - Putaway: api-guide/putaway.md
- - Receiving: api-guide/receiving.md
+ - REST APIs:
+ - Generic API: api-guide/generic.md
+ - Core API:
+ - Identifiers: api-guide/identifier.md
+ - Internal Locations: api-guide/internalLocation.md
+ - Localizations: api-guide/localization.md
+ - Locations: api-guide/location.md
+ - Reason Codes: api-guide/reasonCode.md
+ - Products API:
+ - Categories: api-guide/category.md
+ - Products: api-guide/product.md
+ - Stock Movements API:
+ - Stock Movements: api-guide/stockMovement.md
+ - Stock Movement Items: api-guide/stockMovementItem.md
+ - Stock Movement Status: api-guide/stockMovementStatus.md
+ - Putaways: api-guide/putaway.md
+ - Receiving: api-guide/receiving.md
  - Support:
  - Overview: support/index.md