Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 26c8fae0398b4cfe1312f7812b7f1109fb8f1f51
commit26c8fae0398b4cfe1312f7812b7f1109fb8f1f51[log] [tgz]
authorDixsie Wolmers <dixsie@ibm.com>Mon Oct 26 08:59:51 2020 -0500
committerDerick Montague <derick.montague@ibm.com>Mon Nov 02 15:46:58 2020 +0000
tree5992d8f3d70596bd5595e1248008a3acd6d9bfd5
parent82a346b00e808deade97023b7e1c3c6110cf0bab [diff]
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
2 files changed
tree: 5992d8f3d70596bd5595e1248008a3acd6d9bfd5
  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.