summaryrefslogtreecommitdiff
path: root/docs/guide
AgeCommit message (Collapse)AuthorFilesLines
2020-12-02Add status icon documentationSukanya Pandey8-0/+74
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: I7fa990794533c80bc73bbcd15a0d7191ee70cd11
2020-11-28Add documentation for table searchYoshie Muranaka8-5/+80
Create table directory to organize related images in the same directory and add updates to image path that will fix incorrect path in final build. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I896ed5babc596306c082ca6e79aa3c0948a61227
2020-11-23Add store documentationDixsie Wolmers1-0/+101
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I8597247305e1c3f7958f84b8496a7b75914b85c8
2020-11-19Add unit testing documentationDerick Montague1-0/+126
- Add unit testing section and page Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I693b0576a5815aa7181c5ce068334509b99c7fc7
2020-11-16Fix docs button alignment and image pathDerick Montague3-2/+2
- Create directory in order to use relative path for images and better organize content Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ia5085c1b72c162016ed4da037a15f5f53c744742
2020-11-16Add documentation for table row expansionYoshie Muranaka1-1/+66
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I6123210454c0d18f973cf4ee91a6891a938579a2
2020-11-16Update VuePress configurationYoshie Muranaka4-33/+14
We are moving away from importing application components directly into the VuePress docs. We will document code snippets and add screenshots as a visual example. This commit removes all code and configurations that supported importing dynamic components into VuePress and added images in place of a working component example on the page. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I9a75c5d51de8b6d941e4df7ae977d78c043d36e1
2020-11-07Add documentation for table sortYoshie Muranaka1-4/+60
Create example BmcTable component to eventually showcase all functionality. For now, it only includes table sort. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: Id3f3ac603a58d5dbc8674ec5b2d9d059e935407d
2020-11-07Add documentation for table componentYoshie Muranaka1-0/+93
Adds Table documentation page under Components section with an example of how to create a basic table. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I9033fae662bd46d301edfb02d8a5c108e05017c6
2020-11-06Fix broken links in documentationDerick Montague1-2/+2
There were two broken links on the Getting Started page. These were broke when changed the docs information architecture (IA) and when we removed the guidelines/overview page. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ie12bd1b1320db4e8922c4a08d944d74aaf53a2a4
2020-11-02Add page anatomy quick start to documentationDixsie Wolmers1-0/+76
The page anatomy quick start is intended to give developers a quick reference for building out new pages. Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: Idfed9e62822283c971e228a8a8a186ae05e485ae
2020-10-27Add coding standards overview pageDerick Montague1-0/+23
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184
2020-10-26Remove blank overview pages in documentationDixsie Wolmers2-2/+0
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I6238767b89eda7e0aaebe73faa2ca3e0a61ebf5e
2020-10-26Add icon only button to documentationDerick Montague1-0/+5
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ia00d714b0d33b849a6e9dde8d25e9e9c78d36002
2020-10-20Update theme customizationDerick Montague1-1/+1
- 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
2020-10-20Add narrator to screen reader listDerick Montague1-2/+3
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I4399271998fca392f457d0d1769f1e9337881f44
2020-06-28Update accessibility documentationDerick Montague1-1/+2
- Update IBM Accessibility resources link text - Add IBM Accessibility tools link to tools section Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I602a0f44464ccb373069d37b0313a89ad6311149
2020-05-15Add themes documentationDerick Montague7-4/+6
- 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
2020-05-12Add motion guidelinesDerick Montague1-0/+34
- Update transition global variables in bootstrap to use Carbon motion easing and duration tokens to maintain consistency throughout the application - Remove import of colors helper file into variables and set import order based on dependency Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ibd3fb9438ff236670e5523250d284b59411a7e53
2020-03-20Add alert message component and documentationDerick Montague1-0/+12
- Add custom alert component to simplify the use of custom alerts - Add documentation for using the custom alert - Update the login error alert to use the alert component instead of the Bootstrap-vue component. - Register alert component in enhanceApp - Replace Sass variables used in the StatusIcon component style block to use the Boostrap theme-color and gray Sass functions so the colors can be used in the Vuepress documentation custom components Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ibd93402c919a42bd5c24cc9e7c6c8fc6f17a4db4
2020-03-20Add toast component documentationDerick Montague1-0/+32
- Add documentation that describes when and how to use a toast message with code snippets - Add an informational toast method in the BVToastMixin - Add BVToastMixin to enhaceApp to register mixin globally. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I89bf2aa8b3fdb9294354a80c98ccf692b6e3615a
2020-03-20Add buttons documentationDerick Montague1-0/+23
- Add documentation for how to use buttons - Update markup and CSS rulesets to support icons on the left or the right of text Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ic897f416e85824287360bc7ef5dc47c402d64eba
2020-03-13Revert "Add alert message component and documentation"Derick Montague1-12/+0
This reverts commit 71650fff20c0ad29eb05d770736386863324b64e. Reason for revert: Found an issue with Sass loader when compiling docs that needs to be addressed. Change-Id: Icdd1243665f60849bfb341594452687fcdaeebe2
2020-03-12Add alert message component and documentationDerick Montague1-0/+12
- Add custom alert component to simplify the use of custom alerts - Add documentation for using the custom alert - Update the login error alert to use the alert component instead of the Bootstrap-vue component. - Add the enhanceApp and bmcAppPlugin to extend vuepress to use both the BMC custom and Boostrap-Vue components along with the custom styles Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I5c0b696ca47ddba0df18041d6c5ee7509bf23572
2020-03-12Add accessibility documentationDerick Montague1-1/+43
Create resources and guidance for the accessibility needs of the OpenBMC Web UI. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I6d63ce2e23e403840cfb263622c0bd3dac906abd
2020-03-10Remove unused colors from color paletteDerick Montague1-1/+37
The color palette has been stripped down to a maximum of two colors shades per palette. This works for our design since components use a base color with a lighter color as an accent color. This change reduces the amount of CSS generated by Bootstrap when the CSS is compiled. Github Story: https://github.com/openbmc/webui-vue/issues/2 Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2ddb37f5c89c749a7303799c6f7499ddd83d5a92
2020-03-10Add component overview documentationDerick Montague1-1/+4
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I02de80a70acc0d6e3d1278acb33bbbb004c106b4
2020-02-08Add Getting Started documentationDerick Montague2-1/+33
- Update nav and sidebar - Add content Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I6364d01e016a2954410f154863b497c26453010e
2020-02-08Add coding guidelines and component documentationDerick Montague11-0/+11
Resubmitting after reverted–original commit here https://gerrit.openbmc-project.xyz/c/openbmc/webui-vue/+/28760 - Update README to include instructions on documentation development - Update vue and vue-template-compiler to be compatible with vuepress Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I72049a5888ef6bea6621d0b7948f57a8e4177666
2020-01-29Revert "Add coding guidelines and component documentation"Gunnar Mills11-11/+0
Merged accidentally. Did not have proper +1s/+2s. The author will resubmit. Apologies for the noise. This reverts commit aae4312c3c535253b2d5db7a75503f0237ae423e. Change-Id: I110dd4e12286836aedf84dfba2c4ef07cac08b46 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-29Add coding guidelines and component documentationDerick Montague11-0/+11
- Add deploy script to create and deploy dist file to gh-pages branch - Update README to include instructions on documentation development and deployment - Update vue and vue-template-compiler to be compatible with vuepress - Set vue-date-fns to use specific version - Add shell pages to be completed later Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf
generated by cgit v1.2.3 (git 2.39.0) at 2024-06-29 12:01:44 +0300