Merge pull request #132 from nvisionative/how-to-docs

Documentation changes for issues #129, #130, and #131
nvisionative · Jan 7, 2019 · 85efa3e · 85efa3e
2 parents 5cc7bed + 748dfca
commit 85efa3e
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-[![](http://nvquicktheme.nvisionative.com/portals/0/nvQuickTheme_logo.png)](http://nvquicktheme.nvisionative.com)
+[![](https://nvquicktheme.nvisionative.com/portals/0/nvQuickTheme_logo.png)](https://nvquicktheme.nvisionative.com)
 
-[![Build status](https://nvisionative.visualstudio.com/nvQuickTheme/_apis/build/status/nvQuickTheme-Node.js%20With%20gulp-CI)](https://nvisionative.visualstudio.com/nvQuickTheme/_build/latest?definitionId=1) [![Greenkeeper badge](https://badges.greenkeeper.io/nvisionative/nvQuickTheme.svg)](https://greenkeeper.io/)
+[![Build status](https://nvisionative.visualstudio.com/nvQuickTheme/_apis/build/status/nvQuickTheme-Node.js%20With%20gulp-CI)](https://nvisionative.visualstudio.com/nvQuickTheme/_build/latest?definitionId=1) [![Greenkeeper badge](https://badges.greenkeeper.io/nvisionative/nvQuickTheme.svg)](https://greenkeeper.io/) [![HitCount](http://hits.dwyl.io/nvisionative/nvQuickTheme.svg)](http://hits.dwyl.io/nvisionative/nvQuickTheme)
 
 **nvQuickTheme** is more than just a great minimalist DNN (DotNetNuke) theme.  It is a powerful theme building framework and developer workflow.  This "starter solution" was made with developer efficiency and the ultimate DNN theme performance in mind.  Most DNN themes in the marketplace today are loaded with bloat, which can make theming a pain, and for someone new to DNN, almost impossible.  Our [documentation](https://nvisionative.github.io/nvQuickTheme/) will outline basic usage, modification, and advanced usage of this framework and developer workflow.
 
@@ -26,6 +26,8 @@ The [nvisionative](http://www.nvisionative.com) team has been working in the DNN
 ### Project Setup
 [![nvQuickTheme Video Series - Project Setup](https://img.youtube.com/vi/7UhpbUaeFQc/0.jpg)](https://www.youtube.com/watch?v=7UhpbUaeFQc)
 
+### Color Scheme
+[![nvQuickTheme Video Series - Color Scheme](https://img.youtube.com/vi/o1XW3e8JKfw/0.jpg)](https://www.youtube.com/watch?v=o1XW3e8JKfw)
 
 ---
 [![Brought to the DNN community by nvisionative](http://www.nvquicksite.com/Portals/0/broughtBy-nvisionative.png)](http://www.nvisionative.com)
diff --git a/docs/Add-Custom-Theme-License.md b/docs/Add-Custom-Theme-License.md
@@ -0,0 +1,2 @@
+## Add Custom Theme License
+As of Version 2.0.0 of **nvQuickTheme**, a new file is located in the root (`./`) folder of the project and is named `themeLicense.txt`.  You can place a license within this file and the contents will automatically be displayed during the appropriate installation step within DNN using the project's output theme package.
diff --git a/docs/Add-Custom-Theme-Release-Notes.md b/docs/Add-Custom-Theme-Release-Notes.md
@@ -0,0 +1,2 @@
+## Add Custom Theme Release Notes
+As of Version 2.0.0 of **nvQuickTheme**, a new file is located in the root (`./`) folder of the project and is named `themeReleaseNotes.txt`.  You can place release notes within this file and the contents will automatically be displayed during the appropriate installation step within DNN using the project's output theme package.
diff --git a/docs/Change-Color-Scheme.md b/docs/Change-Color-Scheme.md
@@ -0,0 +1,9 @@
+### Color Scheme
+[![nvQuickTheme Video Series - Color Scheme](https://img.youtube.com/vi/o1XW3e8JKfw/0.jpg)](https://www.youtube.com/watch?v=o1XW3e8JKfw)
+
+## Change Color Scheme
+Most websites are going to key off the colors for the brand being represented.  Following industry best practices, there are typically three colors selected for the website main colors: primary, secondary and tertiary. These are defined within the `./src/scss/variables/_colors.scss` file. Updating these SCSS variable color definitions using HEX or RGB colors will change usage of these throughout the theme.  
+
+There are also colors defined for variants of gray, normal font colors, borders and links. These are all easily modified within this one file.
+
+Additionally, base Bootstrap classes can be used for various colors within your custom theme.
diff --git a/docs/README.md b/docs/README.md
@@ -17,4 +17,7 @@ The [nvisionative](https://www.nvisionative.com) team has been working in the DN
 [![nvQuickTheme Video Series - Intro](https://img.youtube.com/vi/-w0qSTZfBUU/0.jpg)](https://www.youtube.com/watch?v=-w0qSTZfBUU)
 
 ### Project Setup
-[![nvQuickTheme Video Series - Project Setup](https://img.youtube.com/vi/7UhpbUaeFQc/0.jpg)](https://www.youtube.com/watch?v=7UhpbUaeFQc)
+[![nvQuickTheme Video Series - Project Setup](https://img.youtube.com/vi/7UhpbUaeFQc/0.jpg)](https://www.youtube.com/watch?v=7UhpbUaeFQc)
+
+### Color Scheme
+[![nvQuickTheme Video Series - Color Scheme](https://img.youtube.com/vi/o1XW3e8JKfw/0.jpg)](https://www.youtube.com/watch?v=o1XW3e8JKfw)
diff --git a/docs/Working-With-the-Out-Of-Box-Theme.md → docs/Work-With-Out-Of-Box-Theme.md b/docs/Working-With-the-Out-Of-Box-Theme.md → docs/Work-With-Out-Of-Box-Theme.md
diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml
@@ -19,5 +19,11 @@ menu:
         url: /nvQuickTheme/SCSS.html
   - title: How To...
     subfolderitems:
-      - page: Working With the Out-Of-Box Theme
-        url: /nvQuickTheme/Working-With-the-Out-Of-Box-Theme.html
+      - page: Work With Out-Of-Box Theme
+        url: /nvQuickTheme/Work-With-Out-Of-Box-Theme.html
+      - page: Change Color Scheme
+        url: /nvQuickTheme/Change-Color-Scheme.html
+      - page: Add Custom Theme Release Notes
+        url: /nvQuickTheme/Add-Custom-Theme-Release-Notes.html
+      - page: Add Custom Theme License
+        url: /nvQuickTheme/Add-Custom-Theme-License.html
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		## Add Custom Theme License
		As of Version 2.0.0 of nvQuickTheme, a new file is located in the root (`./`) folder of the project and is named `themeLicense.txt`. You can place a license within this file and the contents will automatically be displayed during the appropriate installation step within DNN using the project's output theme package.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		## Add Custom Theme Release Notes
		As of Version 2.0.0 of nvQuickTheme, a new file is located in the root (`./`) folder of the project and is named `themeReleaseNotes.txt`. You can place release notes within this file and the contents will automatically be displayed during the appropriate installation step within DNN using the project's output theme package.