From 38cf569b272f8d5a2e002c5f391225d7d897317d Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Mon, 14 Oct 2019 16:23:39 +0530 Subject: [PATCH] docs: fixes and updates Signed-off-by: Rohit Yadav --- ui/CONTRIBUTING.md | 5 ++++- ui/README.md | 8 ++++---- ui/docs/config.md | 4 +++- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/ui/CONTRIBUTING.md b/ui/CONTRIBUTING.md index 4e4b2653c2c..212326fdbe0 100644 --- a/ui/CONTRIBUTING.md +++ b/ui/CONTRIBUTING.md @@ -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! diff --git a/ui/README.md b/ui/README.md index a008dc90693..938d6717820 100644 --- a/ui/README.md +++ b/ui/README.md @@ -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 diff --git a/ui/docs/config.md b/ui/docs/config.md index 0d386d987b0..4652baf311e 100644 --- a/ui/docs/config.md +++ b/ui/docs/config.md @@ -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