docs: update docs

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>
This commit is contained in:
Rohit Yadav 2019-10-21 22:51:49 +05:30
parent 6b1a4e2fc9
commit ca1c5e80f7
6 changed files with 1942 additions and 3239 deletions

View File

@ -1,6 +1,8 @@
# Documentation
- Router [Configuration](config.md)
- Custom Component
- [List View](listview.md) customisation
- [Resource Detail View](detailview.md) customisation
- [Actions](action.md) customisation
- Styling
- Testing

20
ui/docs/action.md Normal file
View File

@ -0,0 +1,20 @@
## Custom Actions
### Action API
The actions defined for a children show up as group of buttons on the default
autogen view (that shows tables, actions etc.). Each action item should define:
- `api`: The CloudStack API for the action
- `icon`: the icon to be displayed, from AntD's icon set https://vue.ant.design/components/icon/
- `label`: The action button name label
- `listView`: (boolean) whether to show the action button in list view (table)
- `dataView`: (boolean) whether to show the action button in resource/data view
- `groupAction`: Whether the button supports groupable actions when multiple
items are selected in the table
- `args`: list of API arguments to render/show on auto-generated action form
- `show`: function that takes in a records and returns a boolean to control if
the action button needs to be shown or hidden
- `popup`: (boolean) when true, displays any custom component in a popup modal
than in its separate route view
- `component`: the custom component to render the action (in a separate route view)

8
ui/docs/detailview.md Normal file
View File

@ -0,0 +1,8 @@
## Resource Detail View Customisation
Define `details`, an array of keys from the resource object/json that is used
for detail list rendering.
The default resource detail view uses `ResourceView` component which can also
accept `tabs`, an array of custom components that will get rendered as tabs in
the resource view.

3
ui/docs/listview.md Normal file
View File

@ -0,0 +1,3 @@
## Custom Resource List View
Define a custom list rendered using the `component` in the router config.

View File

@ -1,73 +0,0 @@
# What works
TODO: remove this file on reaching feature parity
- Default Authentication
- Role-based API discovery and state management
- URL routing for views, config driven
- General layout:
- Nav bar:
- Config and API discovery based, list of tabs
- Translation in nav bar menu
- Header:
- Logo
- Project select
- Breadcrumb (on desktop)
- Translation menu
- Notification menu
- Logout/user menu
- General features and components:
- Autogenerated view:
- Breadcrumb (on mobile/tablet)
- Actions list: from config
- List view:
- Search and refresh button
- Columns from config
- Cards and table view
- Pagination
- Detail view:
- General info card on left
- Tags, UI-wide resourceType in config
- Annotation/comments for supported views
- Details card:
- Details tab based on details from config
- Other tabs from config
- Dashboard:
- Root admin dashboard
- User dashboard
- Project dashboard
- User Features:
- Compute
- Storage
- Network
- Image
- Project
- Monitor:
- Events
- Alerts
- IAM:
- Users
- Accounts
- Domain
- Roles
- Infra:
- Zone
- Pod
- Cluster
- Host
- Primate storage
- Secondary storage
- System VMs
- VRs
- CPU sockets
- Management servers
- Offerings:
- Compute
- Disk
- Network
- VPC
- System
- Configuration:
- Global settings
- LDAP config
- Hypervisor Capabilities

5073
ui/package-lock.json generated

File diff suppressed because it is too large Load Diff