Age | Commit message (Collapse) | Author | Files | Lines |
|
Change-Id: I2165938df5adfd2b3891cb1335364b78e3f9c474
Signed-off-by: Paul Fertser <fercerpav@gmail.com>
|
|
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
|
|
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
|
|
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
|
|
- 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
|
|
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
|
|
Signed-off-by: Suren Neware <sneware9@in.ibm.com>
Change-Id: I93aa1082880985fef316424a9cf400a9d0a8c2b3
|
|
- Remove pages without content
- Update overview page name
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: Icf26e65d72d2900ddbe216be974930bcc9c0e196
|
|
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: Id75c6e923682f199440ca8d3fd986f034a8f332b
|
|
Includes documentation for multi-lined toast body, refresh app link,
and timestamp.
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: Id95e1858a703cc0be44f1f6de51fd6daab24876d
|
|
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com>
Change-Id: I578ead17e5870ae0981aba775c258b49d697a208
|
|
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
|
|
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: Ic40d7b4580417590b2d465fe359198c92354c242
|
|
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: Id450f9f461c40c5ff7e1c9510b082e88abd1a3ef
|
|
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: I3ab86678e2cc4f9771a07026a417298d716de649
|
|
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com>
Change-Id: Id19854ed326eb55f6443a7015579ea6375193d1f
|
|
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: I52f71d9f3098e28d09c21c9293fe051878a41673
|
|
Components include: b-container, page-title, and page-section.
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: I5933767d44504dbfb87c2772d140de4d0607d4ab
|
|
Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com>
Change-Id: I7fa990794533c80bc73bbcd15a0d7191ee70cd11
|
|
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
|
|
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: I8597247305e1c3f7958f84b8496a7b75914b85c8
|
|
- Add unit testing section and page
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I693b0576a5815aa7181c5ce068334509b99c7fc7
|
|
- 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
|
|
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com>
Change-Id: I6123210454c0d18f973cf4ee91a6891a938579a2
|
|
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
|
|
- Update max-width to use 72 character length
- Remove center align of default content and page-nav
- Decrease padding
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: Iafff0bc2bd0a64e2959997854e1acfb8804578d3
|
|
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
|
|
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
|
|
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
|
|
- Add StatusIcon to ehnaceApp and use the component imported into the
the documentation's component/app-imports directory to resolve fill
rendering bug in the Alert component
- Remove the scoped attribute to make the changes work for alerts in
documentation
- Update StatusIcon component to match changes to application component
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I4090d58f78a1d10d9745ee592424ca0c0c91c610
|
|
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
|
|
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I2dd0fb44a78da62864442fd633654a3e4f887184
|
|
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: I6238767b89eda7e0aaebe73faa2ca3e0a61ebf5e
|
|
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: Ia00d714b0d33b849a6e9dde8d25e9e9c78d36002
|
|
- Remove all color-100 tokens since we are using bootstrap's built-in
functions for color lightening
- Update changed hex values
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I08894fdb64021e38ea8b5c0f47e127d72f3d3ecd
|
|
- 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
|
|
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I4399271998fca392f457d0d1769f1e9337881f44
|
|
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
|
|
- Add '@/' instead of '../../../'
Signed-off-by: Suren Neware <sneware9@in.ibm.com>
Change-Id: Ida1dc26f2bd62f38914a74b729ee8fd143c360ac
|
|
Updated the following body, label, and heading
styles to match new style guide:
- Font sizes
- Font weight
- Line height
- Color
Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: I014c968f6542b697fec8c3b9af781e64ac10794d
|
|
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
|
|
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
|
|
- 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
|
|
These spelling errors were found using
https://github.com/codespell-project/codespell
Change-Id: I8ec1e482a6eedca0f9c3b0282fa7db85cd4243f3
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
|
|
- 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
|
|
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
|
|
- 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
|
|
- 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
|
|
- 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
|
|
- 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
|