summaryrefslogtreecommitdiff
path: root/docs/.vuepress/config.js
AgeCommit message (Collapse)AuthorFilesLines
2020-11-07Add documentation for table componentYoshie Muranaka1-0/+1
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-02Add page anatomy quick start to documentationDixsie Wolmers1-0/+6
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/+1
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184
2020-10-26Remove blank overview pages in documentationDixsie Wolmers1-2/+0
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I6238767b89eda7e0aaebe73faa2ca3e0a61ebf5e
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-20Fix documentation render bugDerick Montague1-0/+9
Using the i18n module in the BVToastMixin file caused an issue with VuePress that resulted in the static files not being created and the documentation rendering as a blank page. - Removed the import of the BVToastMixin - Copied BVToastMixin to docs components and removed i18n - Copied the StatusIcon to docs components to so icons will render with the correct fill color in the toast notifications GitHub Issue: https://github.com/openbmc/webui-vue/issues/40 Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ie479df17d529ad2803c41e7442801e13601a0a02
2020-05-15Add themes documentationDerick Montague1-1/+1
- 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/+1
- 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/+1
- 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/+1
- 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-1/+4
- 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-4/+1
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-1/+4
- 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-02-08Add Getting Started documentationDerick Montague1-4/+4
- 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 Montague1-0/+51
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 Mills1-51/+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 Montague1-0/+51
- 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-07-01 16:53:41 +0300