| commit | f6df801b384118b946bb3b7b3248832ec70cfd0a | [log] [tgz] |
|---|---|---|
| author | Derick Montague <derick.montague@ibm.com> | Wed Dec 09 18:37:11 2020 -0600 |
| committer | Derick Montague <derick.montague@ibm.com> | Tue Dec 15 23:12:41 2020 +0000 |
| tree | 0866ee9fcb2dce300631bdf82a041bfb3a54068a | |
| parent | 34efde291781c01c78e4363d919cdf4d5c90ae43 [diff] |
Update component documentation The component structure was not consistent. We determined how we wanted to save image examples within the component directory, but not all of the components were updated. The result was that some images were not displaying on the component pages. This patchset resolves that issue, along with removing the page component since it is not an actual component within the application. - Add directory for each component, move example images to the directory, and update the image path - Create a page-title and page-section directory and index.md for each - Move content for page-title and page-section from the page.md file into the index.md within the respective component directory - Delete the page.md from the component directory as it is not a component - Update links to page.md in the page-anatomy.md file. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I1e554adf71abb4c84f423a30d3c3b598f678ade0
webui-vue is a web-based user interface for the OpenBMC firmware stack built on Vue.js.
phosphor-webui was built on AngularJS and AngularJS goes End of Life June 30, 2021, this repository is its replacement.
Several, mostly minor, features remain for feature parity. See GitHub Issues label:phosphor-webui-feature-parity for the complete list.
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.
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:
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.
