Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 8b0afbe71f7ef4938e1e1aaaf7ae50c92f319bf0
commit8b0afbe71f7ef4938e1e1aaaf7ae50c92f319bf0[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Thu Jul 09 00:27:12 2020 -0500
committerDerick Montague <derick.montague@ibm.com>Mon Jul 13 15:48:12 2020 -0500
tree94e89ec8d104aa036c739e1e0105c0e4c18dbeb8
parenta88f752908a6188f72274550e0cfe1418cb27f63 [diff]
Update theme file structure in documentation

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
2 files changed
tree: 94e89ec8d104aa036c739e1e0105c0e4c18dbeb8
  1. .github/
  2. docs/
  3. public/
  4. src/
  5. tests/
  6. .browserslistrc
  7. .env.openpower
  8. .eslintrc.js
  9. .gitignore
  10. .npmrc
  11. babel.config.js
  12. CONTRIBUTING.md
  13. format-code.sh
  14. jest.config.js
  15. LICENSE
  16. MAINTAINERS
  17. package-lock.json
  18. package.json
  19. postcss.config.js
  20. README.md
  21. 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, so this repository is hopefully its replacement. At this time, phosphor-webui still contains more features and you should consider using it.

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

The current plan is by the end of June 2020, with exception to the following pages:

  • Firmware
  • SNMP settings
  • KVM
  • Virtual media

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.

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.