| commit | 1bddf79726a38567c6248309a2af6b3e69016a44 | [log] [tgz] |
|---|---|---|
| author | Derick Montague <derick.montague@ibm.com> | Fri Oct 23 08:20:06 2020 -0500 |
| committer | GitHub <noreply@github.com> | Fri Oct 23 08:20:06 2020 -0500 |
| tree | de4490b92117a2765ec5490c2e7aba6ddf017998 | |
| parent | 579cbdf4646fbdf8db2419ee046d812189894afc [diff] |
Add action to deploy documentation
This was merged using Gerrit, but due to being part of the .github
directory the merge is not showing. After this commit, I will rebase
with Gerrit.
- Action will run npm install and docs:build and push the static files
to the gh-pages branch
- Will build documentation and push to the gh-pages branch on every
push to master
- Tested on a forked repo: https://derick-montague.github.io/webui-vue/
- Workflow that was used is the same as being pushed with this commit:
https://github.com/derick-montague/webui-vue/actions/runs/316032970/workflowwebui-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.