Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / caaf7baff0b5995ef6c8fef213f1ec7af34ca911
commitcaaf7baff0b5995ef6c8fef213f1ec7af34ca911[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Fri Oct 09 11:17:48 2020 -0500
committerDerick Montague <derick.montague@ibm.com>Tue Oct 20 10:59:54 2020 -0500
tree07ec4ee03a9a2c594d4914ca853d97573aa06f50
parent0a5b9c6dcd063144896dbdc42f24c681b8b9267c [diff]
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
5 files changed
tree: 07ec4ee03a9a2c594d4914ca853d97573aa06f50
  1. .github/
  2. docs/
  3. public/
  4. src/
  5. tests/
  6. .browserslistrc
  7. .env.ibm
  8. .env.intel
  9. .eslintrc.js
  10. .gitignore
  11. .npmrc
  12. babel.config.js
  13. CONTRIBUTING.md
  14. format-code.sh
  15. jest.config.js
  16. LICENSE
  17. MAINTAINERS
  18. package-lock.json
  19. package.json
  20. postcss.config.js
  21. README.md
  22. vue.config.js
README.md

webui-vue

webui-vue is a web-based user interface for the OpenBMC firmware stack built on Vue.js.

Hold on... What happened to phosphor-webui?

phosphor-webui was built on AngularJS and AngularJS goes End of Life June 30, 2021, this repository is its replacement.

When will this new Vue.js application reach feature parity with phosphor-webui?

Several, mostly minor, features remain for feature parity. See GitHub Issues label:phosphor-webui-feature-parity for the complete list.

Why will this application be better?

As mentioned, this application is built using Vue.js, a modern open-source Model-View-ViewModel JavaScript framework supported by an active community and strong documentation. It has been architected to allow organizations to easily update the theme to support their brand. This rewrite takes advantage of front-end development best practices and does not suffer from some of the anti-patterns that exist in phosphor-webui today.

Should I switch to webui-vue from phosphor-webui?

That is up to you. Several companies have switched.

webui-vue although still missing a few features that were in phosphor-webui, as mentioned above, has the following additional features:

  • Ability to easily theme to meet brand guidelines
  • Accessibility
  • Full Redfish
  • Improved user experience based on user feedback
  • Language translation-ready
  • Modern front-end framework with an active community and future development roadmap

How can I get involved?

Documentation

The documentation for coding standards and components is located in the docs directory. It is created using the VuePress static site generator. Information about how to write documentation can be found on the VuePress website.