summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-07-16Update gray color palette to match style guideDixsie Wolmers1-5/+5
Updated gray palette to match updated design guide - Color changes per page will be addressed in separate commits. Updated sytle guide documentation with new colors. Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: Ic771d932ace38d3abbbf65038f00e25391db5dd0
2020-07-13Update theme file structure in documentationDerick Montague2-34/+74
This update supports a refactor of the SCSS architecture. The Bootstrap files are imported individually to exclude the reboot.scss and type.scss files. These styles conflict with the Vuepress styles and are not needed for documentation. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ida304ecc1fdd1e518f29115ce10752125265330c
2020-07-13Restructure Sass filesYoshie Muranaka5-44/+9
- Consolidate all bootstrap partials - Combine all vendor overrides with BMC custom styles - Updated paths for Vuepress docs Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I1a9f68bdf90edae0d1e38f36ac670bf6426ec8a5
2020-07-08Codespell spelling fixesGunnar Mills2-6/+6
These spelling errors were found using https://github.com/codespell-project/codespell Change-Id: I8ec1e482a6eedca0f9c3b0282fa7db85cd4243f3 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
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-06-26Fix documentation rendering bugDerick Montague2-0/+3
Component documentation was not rendering the components correctly because the rulesets created to override Bootstrap default styles were not being imported. - Import bootstrap and bootstrap-vue overrides - Add Bootstrap reboot styles to fix icon button alignment Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I68665e60935bd9c3aeb6c14a932648805744c53f
2020-05-15Add themes documentationDerick Montague19-21/+440
- 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 Montague2-0/+35
- 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 Montague4-1/+31
- 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 Montague4-1/+79
- 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 Montague4-1/+87
- 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 Montague5-49/+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 Montague5-1/+49
- 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 Montague9-1/+448
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 Montague4-6/+38
- 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 Montague15-0/+71
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 Mills15-71/+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 Montague15-0/+71
- 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 14:19:08 +0300