diff options
| author | Derick Montague <derick.montague@ibm.com> | 2020-04-18 00:49:15 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2020-05-15 00:47:04 +0300 |
| commit | b115aea1eab526971983369986e2d2a56e17ff15 (patch) | |
| tree | 29e3298a5208306a5dae9b55cf1075844ab348a0 /docs/guide/readme.md | |
| parent | 20d8c1867088f47cd970e7cf76a0f8c0c723b6f7 (diff) | |
| download | webui-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/readme.md')
| -rw-r--r-- | docs/guide/readme.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/guide/readme.md b/docs/guide/readme.md new file mode 100644 index 00000000..3a21e6f7 --- /dev/null +++ b/docs/guide/readme.md @@ -0,0 +1,33 @@ +--- +sidebarDepth: 0 +--- + +# Getting Started + +This guide outlines the architecture and technologies used to build the OpenBMC Web UI. This guide exists to serve the following goals: + +1. Improve contributor efficiency while maintaining the quality and consistency of the user interface +1. Act as a collection of community agreed-upon standards + +## Coding Standards +Having an understanding of semantic HTML, CSS, and JavaScript is the critical knowledge required to contribute to this project. The frameworks and libraries used to build this UI include: +- [Vue](https://vuejs.org/) +- [Vuex](https://vuex.vuejs.org/) +- [Vue Router](https://router.vuejs.org/) +- [Axios](https://github.com/axios/axios) +- [Bootstrap-vue](https://bootstrap-vue.js.org/) +- [Vuelidate](https://vuelidate.js.org/) +- [Vue I18n](https://kazupon.github.io/vue-i18n/) + +::: tip +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, 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. + |