#
c2f8f34e |
| 12-May-2021 |
Derick Montague <derick.montague@ibm.com> |
Update docs theme section to customization
The themes section of the webui style guide contained a section named theme. This section also included information about the environmental builds. The nam
Update docs theme section to customization
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
show more ...
|
#
dbc691c6 |
| 24-Mar-2021 |
Dixsie <dixsie@ibm.com> |
Add form quick start documentation
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
Add form quick start documentation
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
show more ...
|
#
56ada53a |
| 08-Mar-2021 |
Sandeepa Singh <sandeepa.singh@ibm.com> |
Add internationalization documentation
- Explains how internationalization makes the OpenBMC Web UI multilingual - Explains the use of vue-i18n
Signed-off-by: Sandeepa Singh <sandeepa.singh@ibm.c
Add internationalization documentation
- 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
show more ...
|
#
9a25c805 |
| 25-Feb-2021 |
Derick Montague <derick.montague@ibm.com> |
Update coding standards documentation
- Remove pages without content - Update overview page name
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Icf26e65d72d2900ddbe216be974930b
Update coding standards documentation
- Remove pages without content - Update overview page name
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Icf26e65d72d2900ddbe216be974930bcc9c0e196
show more ...
|
#
0f22907a |
| 27-Nov-2020 |
Sukanya Pandey <sukapan1@in.ibm.com> |
Add form file documentation
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: I578ead17e5870ae0981aba775c258b49d697a208
|
#
f6df801b |
| 09-Dec-2020 |
Derick Montague <derick.montague@ibm.com> |
Update component documentation
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 updat
Update component documentation
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
show more ...
|
#
96d9a6aa |
| 03-Nov-2020 |
Sukanya Pandey <sukapan1@in.ibm.com> |
Add info tooltip documentation
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: Id19854ed326eb55f6443a7015579ea6375193d1f
|
#
e2707ef0 |
| 15-Nov-2020 |
Dixsie Wolmers <dixsie@ibm.com> |
Add page components documentation
Components include: b-container, page-title, and page-section.
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I5933767d44504dbfb87c2772d140de4d0607d4ab
|
#
432134d4 |
| 13-Nov-2020 |
Sukanya Pandey <sukapan1@in.ibm.com> |
Add status icon documentation
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com> Change-Id: I7fa990794533c80bc73bbcd15a0d7191ee70cd11
|
#
e080ba7a |
| 12-Nov-2020 |
Yoshie Muranaka <yoshiemuranaka@gmail.com> |
Add documentation for table search
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:
Add documentation for table search
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
show more ...
|
#
8da32b5c |
| 16-Nov-2020 |
Dixsie Wolmers <dixsie@ibm.com> |
Add store documentation
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I8597247305e1c3f7958f84b8496a7b75914b85c8
|
#
e7eb9dc6 |
| 27-Oct-2020 |
Derick Montague <derick.montague@ibm.com> |
Add unit testing documentation
- Add unit testing section and page
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I693b0576a5815aa7181c5ce068334509b99c7fc7
|
#
ab93192e |
| 16-Nov-2020 |
Derick Montague <derick.montague@ibm.com> |
Fix docs button alignment and image path
- 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:
Fix docs button alignment and image path
- 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
show more ...
|
#
d35132d8 |
| 11-Nov-2020 |
Yoshie Muranaka <yoshiemuranaka@gmail.com> |
Update VuePress configuration
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 c
Update VuePress configuration
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
show more ...
|
#
111325b1 |
| 03-Nov-2020 |
Yoshie Muranaka <yoshiemuranaka@gmail.com> |
Add documentation for table component
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
Add documentation for table component
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
show more ...
|
#
26c8fae0 |
| 26-Oct-2020 |
Dixsie Wolmers <dixsie@ibm.com> |
Add page anatomy quick start to documentation
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
Add page anatomy quick start to documentation
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
show more ...
|
#
736f2a4b |
| 26-Oct-2020 |
Derick Montague <derick.montague@ibm.com> |
Add coding standards overview page
Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184
|
#
459c1edb |
| 26-Oct-2020 |
Dixsie Wolmers <dixsie@ibm.com> |
Remove blank overview pages in documentation
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com> Change-Id: I6238767b89eda7e0aaebe73faa2ca3e0a61ebf5e
|
#
35b2bbf0 |
| 09-Oct-2020 |
Derick Montague <derick.montague@ibm.com> |
Update theme customization
- 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
Sign
Update theme customization
- 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
show more ...
|
#
caaf7baf |
| 09-Oct-2020 |
Derick Montague <derick.montague@ibm.com> |
Fix documentation render bug
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 bla
Fix documentation render bug
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
show more ...
|
#
b115aea1 |
| 17-Apr-2020 |
Derick Montague <derick.montague@ibm.com> |
Add themes documentation
- 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 st
Add themes documentation
- 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
show more ...
|
#
221b3187 |
| 14-Apr-2020 |
Derick Montague <derick.montague@ibm.com> |
Add motion guidelines
- Update transition global variables in bootstrap to use Carbon motion easing and duration tokens to maintain consistency throughout the application - Remove import of colors h
Add motion guidelines
- 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
show more ...
|
#
fd22b5b0 |
| 13-Mar-2020 |
Derick Montague <derick.montague@ibm.com> |
Add alert message component and documentation
- 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 t
Add alert message component and documentation
- 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
show more ...
|
#
4e90eed0 |
| 03-Mar-2020 |
Derick Montague <derick.montague@ibm.com> |
Add toast component documentation
- 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
Add toast component documentation
- 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
show more ...
|
#
3f6710a0 |
| 04-Mar-2020 |
Derick Montague <derick.montague@ibm.com> |
Add buttons documentation
- 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.montag
Add buttons documentation
- 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
show more ...
|