Update theme customization
- Move the env.md from /env directory to be displayed in the theming
section
- Update copy to remove references to downstream changes since changes
are made upstream
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I5ed3c62a9534c071b6dbd7f69ed35d457353a628
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 8b7be97..9043606 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -53,7 +53,7 @@
]
}
],
- "/themes/": ["", "customize"]
+ "/themes/": ["", "customize", "env"]
},
},
configureWebpack: {
diff --git a/docs/guide/guidelines/colors.md b/docs/guide/guidelines/colors.md
index dd6e82a..7ef6c15 100644
--- a/docs/guide/guidelines/colors.md
+++ b/docs/guide/guidelines/colors.md
@@ -1,7 +1,7 @@
# Colors
This color palette has been agreed upon by the OpenBMC community and differs from the Bootstrap color patterns. The OpenBMC palette includes custom hex values, along with additional blue, green, red, and yellow color variables used as accent colors for components. The `.scss` component files use these accent colors to override default styles set by the Bootstrap library.
-- [Learn more about downstream customization](/themes/)
+- [Learn more about theme customization](/themes/)
- [Open an issue in the OpenBMC webui-vue repo](https://github.com/openbmc/webui-vue/issues/new/choose) to request a change
- [Learn more about Bootstrap colors](https://getbootstrap.com/docs/4.4/getting-started/theming/#theme-colors)
diff --git a/docs/themes/customize.md b/docs/themes/customize.md
index 1af2122..bee769a 100644
--- a/docs/themes/customize.md
+++ b/docs/themes/customize.md
@@ -1,6 +1,12 @@
# How to customize
Customization of the application requires knowledge of Sass and CSS. It also will require becoming familiar with the Bootstrap and Bootstrap-Vue component libraries. This section outlines the global options and variables that can be removed or updated to meet organizational brand guidelines.
+## Environment specific builds
+Any organization can create a build that meets their branding and other customization needs. This includes customization of the state store, routing, application navigation, and theming.
+
+### Configuring environment specific builds
+The complete instructions can be found in the `env` directory in a file called env.md or by viewing the [Configuring environment specific builds page](./env.md)
+
## Bootstrap Sass Options
The Bootstrap Sass options are global styling toggles. The naming convention for these built-in variables is `enabled-*`.
diff --git a/src/env/env.md b/docs/themes/env.md
similarity index 100%
rename from src/env/env.md
rename to docs/themes/env.md
diff --git a/docs/themes/readme.md b/docs/themes/readme.md
index 0b391f6..a37baca 100644
--- a/docs/themes/readme.md
+++ b/docs/themes/readme.md
@@ -1,7 +1,7 @@
# Overview
-The best way to change the overall look and feel of the OpenBMC Web UI is to update the following files in a downstream repository. This section discusses the structure and purpose of the theme files and how to customize the application using Bootstrap theming.
+ This section discusses the structure and purpose of the theme files and how to customize the application using Bootstrap theming.
[Read more about Bootstrap Theming](https://getbootstrap.com/docs/4.0/getting-started/theming)
@@ -36,11 +36,14 @@
├─ _bootstrap-grid.scss
├─ _buttons.scss
├─ _calendar.scss
+ ├─ _card.scss
├─ _dropdown.scss
├─ _forms.scss
├─ _index.scss
+ ├─ _kvm.scss
├─ _modal.scss
├─ _pagination.scss
+ ├─ _sol.scss
├─ _tables.scss
└─ _toasts.scss
└─ helpers