summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDerick Montague <derick.montague@ibm.com>2020-02-07 21:06:41 +0300
committerDerick Montague <derick.montague@ibm.com>2020-02-08 00:47:58 +0300
commit7fc4cd7dbe2f9eb38bb876aa4febf8f5e13a279f (patch)
tree44881169f8919e396acaef6f5fa95fde2f321c22
parent365bce5f93f85408cd1b6393e69342e55a0a25ee (diff)
downloadwebui-vue-7fc4cd7dbe2f9eb38bb876aa4febf8f5e13a279f.tar.xz
Add Getting Started documentation
- Update nav and sidebar - Add content Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I6364d01e016a2954410f154863b497c26453010e
-rw-r--r--docs/.vuepress/config.js8
-rw-r--r--docs/guide/getting-started.md1
-rw-r--r--docs/guide/index.md33
-rw-r--r--docs/index.md2
4 files changed, 38 insertions, 6 deletions
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 68073188..5a8e601f 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -8,7 +8,7 @@ module.exports = {
nav: [
{
text: "Guide",
- link: "/guide/getting-started"
+ link: "/guide/"
},
{
text: "Themes",
@@ -22,7 +22,7 @@ module.exports = {
sidebarDepth: 1,
sidebar: {
"/guide/": [
- "getting-started",
+ "",
{
title: "Coding Standards",
children: [
@@ -44,8 +44,8 @@ module.exports = {
title: "Components",
children: ["/guide/components/", "/guide/components/page-section"]
}
- ]
+ ],
+ "/themes/": [""]
},
- "/themes/": [""]
}
}; \ No newline at end of file
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
deleted file mode 100644
index 8b3a7945..00000000
--- a/docs/guide/getting-started.md
+++ /dev/null
@@ -1 +0,0 @@
-# Getting Started \ No newline at end of file
diff --git a/docs/guide/index.md b/docs/guide/index.md
new file mode 100644
index 00000000..6cf2197c
--- /dev/null
+++ b/docs/guide/index.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 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.
+
diff --git a/docs/index.md b/docs/index.md
index 1aaa4adc..0630f0d0 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,5 +3,5 @@ home: true
heroImage: openbmc-logo.svg
heroText: Style Guide and Coding Conventions
actionText: Getting Started
-actionLink: /guide/getting-started
+actionLink: /guide/
--- \ No newline at end of file