docs: fixes and updates

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>
This commit is contained in:
Rohit Yadav 2019-10-14 16:23:39 +05:30
parent 64a3035db3
commit 38cf569b27
3 changed files with 11 additions and 6 deletions

View File

@ -6,6 +6,9 @@ This document covers how to contribute to the Primate project. Primate uses Gith
These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one.
Your proposed code changes will be published to your own fork of the Primate project and you will submit a Pull Request for your changes to be added.
Please refer to project [docs](docs) for reference on standard way of component
configuration, development, usage, extension and testing.
*Lets get started!!!*
### Bug fixes
@ -18,7 +21,7 @@ Since the goal is a stable master, bug fixes should be "merged forward" to the n
### New features
Development should be done in a feature branch, branched off of master.
Send a PR (steps below) to get it into master (at least 1x LGTM applies).
Send a PR (steps below) to get it into master (at least 2x LGTM applies).
PR will only be merged when master is open, will be held otherwise until master is open again.
No back porting / cherry-picking features to existing branches!

View File

@ -89,10 +89,10 @@ Primate uses the following:
### History
The project was created by [Rohit Yadav](rohityadav.cloud) over several weekends
during late 2018 and early 2019. During ApacheCon CCCUS19, on 9th September
2019, Primate was introduced and demoed as part of the talk [Modern UI for
CloudStack](https://rohityadav.cloud/files/talks/cccna19-primate.pdf)
The project was created by [Rohit Yadav](https://rohityadav.cloud) over several
weekends during late 2018 and early 2019. During ApacheCon CCCUS19, on 9th
September 2019, Primate was introduced and demoed as part of the talk [Modern UI
for CloudStack](https://rohityadav.cloud/files/talks/cccna19-primate.pdf)
([video](https://www.youtube.com/watch?v=F2KwZhechzs)).
### License

View File

@ -36,8 +36,10 @@ The children should have:
- `icon`: the icon to be displayed, from AntD's icon set https://vue.ant.design/components/icon/
- `permission`: the array of API to check against auto-discovered APIs
- `columns`: list of column keys for list view rendering
- `details`: list of keys for detail list rendering for a resource
- `tabs`: array of custom components that will get rendered as tabs in the
resource view
- `component`: the custom component for rendering the route view
- `viewComponent`: the custom component for rendering a resource from the
default list view (table)
- `actions`: arrays of actions/buttons