Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 492875622b39cb2cf04bbb9248b6ed0c52ced2df
commit492875622b39cb2cf04bbb9248b6ed0c52ced2df[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Tue Mar 16 19:52:33 2021 -0500
committerDerick Montague <derick.montague@ibm.com>Mon Mar 22 13:27:10 2021 +0000
tree665449e11841591a8aae5f4f347a3a88936a2d7a
parentb0fadef1f96df99ff5eb0637527f04bc793c8d6e [diff]
Update text wrapping in documentation

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
21 files changed
tree: 665449e11841591a8aae5f4f347a3a88936a2d7a
  1. .github/
  2. docs/
  3. public/
  4. src/
  5. tests/
  6. .browserslistrc
  7. .env.ibm
  8. .env.intel
  9. .eslintrc.js
  10. .gitattributes
  11. .gitignore
  12. .npmrc
  13. babel.config.js
  14. CONTRIBUTING.md
  15. format-code.sh
  16. jest.config.js
  17. LICENSE
  18. MAINTAINERS
  19. package-lock.json
  20. package.json
  21. postcss.config.js
  22. README.md
  23. 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.