summaryrefslogtreecommitdiff
path: root/docs/guide/guidelines
AgeCommit message (Collapse)AuthorFilesLines
2021-07-22docs: expand guide with vue-i18n-extract.js examplesPaul Fertser1-3/+16
This internationalization documentation patch provides the developers with specific recommendations on using vue-i18n-extract.js tool to ensure translations consistency. Signed-off-by: Paul Fertser <fercerpav@gmail.com> Change-Id: I506091c97043ad3f50c4753daddd450abe9744fc
2021-06-09Update docs theme section to customizationDerick Montague1-1/+1
The themes section of the webui style guide contained a section named theme. This section also included information about the environmental builds. The name was misleading and confusing, so we determined in the GUI Design Work Group to update the section name. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Iad245199048f65f346e6c033a766605f303b0ade
2021-03-23Add internationalization documentationSandeepa Singh1-0/+57
- Explains how internationalization makes the OpenBMC Web UI multilingual - Explains the use of vue-i18n Signed-off-by: Sandeepa Singh <sandeepa.singh@ibm.com> Change-Id: Ica273814a857f37502b9bb71800de7660d4fa49b
2021-03-22Update text wrapping in documentationDerick Montague2-11/+37
To meet best practices and standards for markdown, this commit updates all markdown files used for the VuePress documentation so that each line is limited to 80 characters. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I0cadb33343ce1bc331dfefd096d8137a04c33604
2020-10-26Remove blank overview pages in documentationDixsie Wolmers1-1/+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-05-15Add themes documentationDerick Montague2-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/+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-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-02-08Add coding guidelines and component documentationDerick Montague3-0/+3
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 Mills3-3/+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 Montague3-0/+3
- 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 22:34:05 +0300