Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / e827dd235bb4c459a5320ad00c0b0ba7b8bd0468
commite827dd235bb4c459a5320ad00c0b0ba7b8bd0468[log] [tgz]
authorPaul Fertser <fercerpav@gmail.com>Thu Jul 22 09:57:31 2021 +0000
committerPaul Fertser <fercerpav@gmail.com>Thu Jul 22 14:52:42 2021 +0000
treecbde2cf2df0d523fa1033cf9c7e20e5213983124
parent8b1beffd683a400eec8454ac155f84f0ebcd3f3f [diff]
docs: expand guide with vue-i18n-extract.js examples

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
1 file changed
tree: cbde2cf2df0d523fa1033cf9c7e20e5213983124
  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. .shellcheck
  14. babel.config.js
  15. CONTRIBUTING.md
  16. format-code.sh
  17. jest.config.js
  18. LICENSE
  19. MAINTAINERS
  20. package-lock.json
  21. package.json
  22. postcss.config.js
  23. README.md
  24. run-ci
  25. 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.