summaryrefslogtreecommitdiff
path: root/docs/guide
AgeCommit message (Collapse)AuthorFilesLines
2025-05-01i18n: fix global method in page-title guideJason M. Bills1-1/+1
The change from i18n.t method to i18n.global.t for vue3 support was missed in the page-title guide. I found this on the Intel router and am pushing this for completeness. Change-Id: I97c993e36caa07af6df7c1ae3124e4f9380c493b Signed-off-by: Jason M. Bills <jason.m.bills@intel.com>
2024-04-18Focus default action in modal windowsPaul Fertser1-0/+1
Users of common WIMP GUIs (as opposed to interfaces primarily meant for touch input) expect dialog boxes to have keyboard focus set on the button for default action so that it can be executed by a single key press. Usually that is chosen to proceed with the operation but in cases where that leads to data loss the UI designers often pre-select Cancel as a precaution. This patch adds suitable property to all invocations of msgBoxConfirm() method of `this.$bvModal` BootstrapVue object. For regular actions the confirmation button is selected and can be activated by Enter or Space bar. For actions deemed dangerous Cancel is focused instead so it takes two key presses (first being Tab to shift the focus) to prooceed. This also improves accessibility following the Web Content Accessibility Guidelines (WCAG) published by W3C. Tested: manually verified that modals are consistently shown with the specified button focused, Enter and Space bar key presses produce the same effect as left pointer button click: when Cancel is focused it just closes the window, when OK is focused it sends the corresponding request to the Redfish endpoint. Change-Id: I66bfd02e48e08dc18994b11bbdd5d6b3ea27047f Signed-off-by: Paul Fertser <fercerpav@gmail.com>
2023-07-11Fix CI failGunnar Mills1-1/+1
Looks like a new bump of the tools caught us. Saw this fail on https://gerrit.openbmc.org/c/openbmc/webui-vue/+/63442 Fails like: ``` diff --git a/docs/guide/components/page-section/index.md b/docs/guide/components/page-section/index.md index 94113c5..a37d67c 100644 --- a/docs/guide/components/page-section/index.md +++ b/docs/guide/components/page-section/index.md @@ -6,7 +6,7 @@ string will be rendered in an `h2` header element. ```vue // Example: `src/views/AccessControl/Ldap/Ldap.vue` - <page-section :section-title="$t('pageLdap.settings')"> +<page-section :section-title="$t('pageLdap.settings')"></page-section> ``` ``` Change-Id: I1ada18a09050c5fbcc773a28ef20b8af1b7e84e4 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2022-12-08prettier: re-formatPatrick Williams21-280/+305
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML files to have consistent formatting for these file types. Re-run the formatter on the whole repository. Change-Id: I2804ee3ab5ff6bcbf986b028db2fafec8e616779 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
2021-08-04docs: guide: fix broken links to guidelines and customizationPaul Fertser1-2/+2
Change-Id: I2165938df5adfd2b3891cb1335364b78e3f9c474 Signed-off-by: Paul Fertser <fercerpav@gmail.com>
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-04-06Add form quick start documentationDixsie1-0/+126
Form quick start documentation contains info on using the form and form group components, and the Vuelidate plugin. This doc also provides a template for creating a new form. Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I5d05141ff05cd069e55853a8b2cb4adecb3c848a
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 Montague18-129/+376
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
2021-03-02Update button documentation for icon only buttonSurenNeware1-10/+29
Signed-off-by: Suren Neware <sneware9@in.ibm.com> Change-Id: I93aa1082880985fef316424a9cf400a9d0a8c2b3
2021-02-26Update coding standards documentationDerick Montague3-3/+1
- Remove pages without content - Update overview page name Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Icf26e65d72d2900ddbe216be974930bcc9c0e196
2021-02-17Unit testing docs typo fixDixsie Wolmers1-2/+2
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: Id75c6e923682f199440ca8d3fd986f034a8f332b
2021-02-16Add documentation for BVToastMixin enhancementsYoshie Muranaka2-0/+24
Includes documentation for multi-lined toast body, refresh app link, and timestamp. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: Id95e1858a703cc0be44f1f6de51fd6daab24876d
2020-12-16Add form file documentationSukanya Pandey2-0/+28
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: I578ead17e5870ae0981aba775c258b49d697a208
2020-12-16Update component documentationDerick Montague10-71/+37
The component structure was not consistent. We determined how we wanted to save image examples within the component directory, but not all of the components were updated. The result was that some images were not displaying on the component pages. This patchset resolves that issue, along with removing the page component since it is not an actual component within the application. - Add directory for each component, move example images to the directory, and update the image path - Create a page-title and page-section directory and index.md for each - Move content for page-title and page-section from the page.md file into the index.md within the respective component directory - Delete the page.md from the component directory as it is not a component - Update links to page.md in the page-anatomy.md file. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I1e554adf71abb4c84f423a30d3c3b598f678ade0
2020-12-07Add documentation for table paginationYoshie Muranaka2-1/+96
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: Ic40d7b4580417590b2d465fe359198c92354c242
2020-12-05Add documentation for table batch actionsYoshie Muranaka3-1/+94
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: Id450f9f461c40c5ff7e1c9510b082e88abd1a3ef
2020-12-04Add documentation for table filterYoshie Muranaka3-1/+73
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I3ab86678e2cc4f9771a07026a417298d716de649
2020-12-03Add info tooltip documentationSukanya Pandey1-0/+15
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: Id19854ed326eb55f6443a7015579ea6375193d1f
2020-12-02Add documentation for table row actionsYoshie Muranaka2-1/+80
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I52f71d9f3098e28d09c21c9293fe051878a41673
2020-12-02Add page components documentationDixsie Wolmers4-15/+72
Components include: b-container, page-title, and page-section. Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I5933767d44504dbfb87c2772d140de4d0607d4ab
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
generated by cgit v1.2.3 (git 2.39.0) at 2025-06-07 23:18:43 +0300