summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorDerick Montague <derick.montague@ibm.com>2020-04-18 00:49:15 +0300
committerDerick Montague <derick.montague@ibm.com>2020-05-15 00:47:04 +0300
commitb115aea1eab526971983369986e2d2a56e17ff15 (patch)
tree29e3298a5208306a5dae9b55cf1075844ab348a0 /docs/guide
parent20d8c1867088f47cd970e7cf76a0f8c0c723b6f7 (diff)
downloadwebui-vue-b115aea1eab526971983369986e2d2a56e17ff15.tar.xz
Add themes documentation
- Renamed all index.md to readme.md to make consuming the documentation from the Github repo easier. VuePress treats index.md and readme.md the same way when building the static pages. - Added theme section overview documentation - Added how to customize documentation - Added custom style imports to support OpenBMC Web UI component documentation to remove Bootstrap framework base styles that conflict with the Vuepress theme - Found occurrences of the word Sass in upper-case and changed to use sentence case. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: If5588f88a3d75761cc47e85a3fb0a582b31d373c
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/coding-standards/readme.md (renamed from docs/guide/coding-standards/index.md)0
-rw-r--r--docs/guide/coding-standards/sass.md2
-rw-r--r--docs/guide/components/alert.md4
-rw-r--r--docs/guide/components/readme.md (renamed from docs/guide/components/index.md)0
-rw-r--r--docs/guide/guidelines/colors.md2
-rw-r--r--docs/guide/guidelines/readme.md (renamed from docs/guide/guidelines/index.md)0
-rw-r--r--docs/guide/readme.md (renamed from docs/guide/index.md)2
7 files changed, 6 insertions, 4 deletions
diff --git a/docs/guide/coding-standards/index.md b/docs/guide/coding-standards/readme.md
index 4bba659e..4bba659e 100644
--- a/docs/guide/coding-standards/index.md
+++ b/docs/guide/coding-standards/readme.md
diff --git a/docs/guide/coding-standards/sass.md b/docs/guide/coding-standards/sass.md
index b990f50c..0467ffa0 100644
--- a/docs/guide/coding-standards/sass.md
+++ b/docs/guide/coding-standards/sass.md
@@ -1 +1 @@
-# SASS Conventions and Standards \ No newline at end of file
+# Sass Conventions and Standards \ No newline at end of file
diff --git a/docs/guide/components/alert.md b/docs/guide/components/alert.md
index 768aa873..1ad965bd 100644
--- a/docs/guide/components/alert.md
+++ b/docs/guide/components/alert.md
@@ -3,7 +3,9 @@ An alert is an inline message that contains a short description that a user cann
[Learn more about Bootstrap-vue alert options](https://bootstrap-vue.js.org/docs/components/alert)
-<BmcAlerts />
+<alert show variant="warning">This is a warning message</alert>
+<alert show variant="danger">This is an error message</alert>
+<alert show variant="info">This is an info message</alert>
```vue
<alert show variant="warning">This is a warning message</alert>
diff --git a/docs/guide/components/index.md b/docs/guide/components/readme.md
index f10a1317..f10a1317 100644
--- a/docs/guide/components/index.md
+++ b/docs/guide/components/readme.md
diff --git a/docs/guide/guidelines/colors.md b/docs/guide/guidelines/colors.md
index b4e6d6cc..dd6e82ad 100644
--- a/docs/guide/guidelines/colors.md
+++ b/docs/guide/guidelines/colors.md
@@ -2,7 +2,7 @@
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/)
-- [Open an issue in the OpenBMC webui-vue repo](https://github.com/openbmc/webui-vue/issues/new) to request a change
+- [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)
## Grays
diff --git a/docs/guide/guidelines/index.md b/docs/guide/guidelines/readme.md
index 4bba659e..4bba659e 100644
--- a/docs/guide/guidelines/index.md
+++ b/docs/guide/guidelines/readme.md
diff --git a/docs/guide/index.md b/docs/guide/readme.md
index 6cf2197c..3a21e6f7 100644
--- a/docs/guide/index.md
+++ b/docs/guide/readme.md
@@ -26,7 +26,7 @@ Acquiring an understanding of these technologies will also be necessary.
You will find more information about the standards and best practices in the [Coding Standards section of this guide](/coding-standards/).
## Guidelines
-The [guidelines section](/guide/guidelines) contains the OpenBMC community agreed-upon decisions on color and typography within the application. How to theme the application to meet company brand guidelines is documented in [Themes](/themes).
+The [guidelines section](/guide/guidelines) contains the OpenBMC community agreed-upon decisions on color, motion, and typography within the application. How to theme the application to meet company brand guidelines is documented in [Themes](/themes).
## Components
The [components section](/guide/components/) is a guide to using both custom Vue components and components from the Bootstrap-Vue library.