Navigation Menu

Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sunface committed Nov 27, 2020
1 parent 84b1daf commit c205689
Show file tree
Hide file tree
Showing 148 changed files with 526 additions and 20,764 deletions.
21 changes: 9 additions & 12 deletions README_CN.md
Expand Up @@ -10,17 +10,14 @@ DataV是一个类似Grafana的数据查询、展示、告警平台,支持Metri

## 功能特性

| 功能 | 描述 |
| 特性 | 描述 |
|:------|:------------:|
| **类似Grafana** | 在核心功能上DataV类似Grafana |
| **图表插件** | 高性能、可扩展、漂亮的图表插件系统,同时支持丰富的选项配置 |
| **动态Dashboard** | 支持自定义Dashboard,同时可以使用模版变量来增强Dashboard的可复用性|
| **酷炫大屏** | 自定义大屏,可以很好满足各种大屏的需求 |
| **Iframe API** | 你可以把DataV的页面嵌入进自己的网站中,我们提供了丰富的API来帮助你更好的iframe |
| **自定义页面菜单导航** | 我的菜单我做主,图表页面可以放在任何菜单导航中,实现更方便的访问和管理 |
| **报表生成** | 只需要勾勾选选,就能快速生成一份强大的报表,同时支持邮件自动推送 |
| **配置导出和导入** | 支持多个级别的配置管理,同时能做到自动备份 |
| **多环境** | 可以自定义多套环境,让你的测试、预发、生产、容器等图表全部在一套系统中展现 |
|**多语言、多主题**|默认支持中/英语言、白天/黑夜主题,同时支持在线自定义主题|
| **优秀的代码**|全部用Typescript + React + Go实现,完善的测试覆盖以及精简的代码实现|
| **插件化** | 高性能,可扩展,美观,可配置 |
| **动态仪表盘** | 使用丰富的配置项来打造强大的动态图表 |
| **可交互图表** | 可以为图表设置鼠标点击事件,来自定义图表交互行为 |
| **数据大屏** | 利用装饰性组件,实现多样化的数据大屏酷炫效果 |
| **告警** | 为指标性数据设置告警阈值,可以精确到曲线级别(Grafana是图表级别) |
| **模版变量** | 本地变量类似grafana,全局变量是多个仪表盘可以共享的变量 |
| **权限控制** | 企业级的权限控制,可以实现用户、团队、仪表盘三个维度的同时控制 |
| **自定义侧边菜单=** | 通过链接仪表盘到侧边菜单项,你可以实现自定义的二级菜单,打造团队的个性化菜单导航 |

160 changes: 18 additions & 142 deletions docs/src/layouts/DocumentationLayout.js
Expand Up @@ -61,151 +61,27 @@ export function DocumentationLayout(props) {
nav = {
'Getting started': [
pages['installation'],
pages['release-notes']
],
'Core Concepts': [
pages['utility-first'],
pages['responsive-design'],
pages['pseudo-class-variants'],
pages['adding-base-styles'],
pages['extracting-components'],
pages['adding-new-utilities'],
pages['functions-and-directives'],
],
Customization: [
pages['configuration'],
pages['theme'],
pages['breakpoints'],
pages['customizing-colors'],
pages['customizing-spacing'],
pages['configuring-variants'],
pages['plugins'],
],
'Base Styles': [pages['preflight']],
Layout: [
pages['container'],
pages['box-sizing'],
pages['display'],
pages['float'],
pages['clear'],
pages['object-fit'],
pages['object-position'],
pages['overflow'],
pages['overscroll-behavior'],
pages['position'],
pages['top-right-bottom-left'],
pages['visibility'],
pages['z-index'],
],
Flexbox: [
pages['flex-direction'],
pages['flex-wrap'],
pages['flex'],
pages['flex-grow'],
pages['flex-shrink'],
pages['order'],
],
Grid: [
pages['grid-template-columns'],
pages['grid-column'],
pages['grid-template-rows'],
pages['grid-row'],
pages['grid-auto-flow'],
pages['grid-auto-columns'],
pages['grid-auto-rows'],
pages['gap'],
],
'Box Alignment': [
pages['justify-content'],
pages['justify-items'],
pages['justify-self'],
pages['align-content'],
pages['align-items'],
pages['align-self'],
pages['place-content'],
pages['place-items'],
pages['place-self'],
],
Spacing: [pages['padding'], pages['margin'], pages['space']],
Sizing: [
pages['width'],
pages['min-width'],
pages['max-width'],
pages['height'],
pages['min-height'],
pages['max-height'],
],
Typography: [
pages['font-family'],
pages['font-size'],
pages['font-smoothing'],
pages['font-style'],
pages['font-weight'],
pages['font-variant-numeric'],
pages['letter-spacing'],
pages['line-height'],
pages['list-style-type'],
pages['list-style-position'],
pages['placeholder-color'],
pages['placeholder-opacity'],
pages['text-align'],
pages['text-color'],
pages['text-opacity'],
pages['text-decoration'],
pages['text-transform'],
pages['vertical-align'],
pages['whitespace'],
pages['word-break'],
],
Backgrounds: [
pages['background-attachment'],
pages['background-clip'],
pages['background-color'],
pages['background-opacity'],
pages['background-position'],
pages['background-repeat'],
pages['background-size'],
pages['background-image'],
pages['gradient-color-stops'],
],
Borders: [
pages['border-radius'],
pages['border-width'],
pages['border-color'],
pages['border-opacity'],
pages['border-style'],
pages['divide-width'],
pages['divide-color'],
pages['divide-opacity'],
pages['divide-style'],
],
Tables: [pages['border-collapse'], pages['table-layout']],
Effects: [pages['box-shadow'], pages['opacity']],
'Transitions and Animation': [
pages['transition-property'],
pages['transition-duration'],
pages['transition-timing-function'],
pages['transition-delay'],
pages['animation'],
pages['tutorial'],
],
Transforms: [
pages['scale'],
pages['rotate'],
pages['translate'],
pages['skew'],
pages['transform-origin'],
'Beginner tutorial': [
pages['lang-theme'],
pages['create-datasource'],
pages['create-dashboard'],
pages['search-dashboard'],
pages['create-folder'],
pages['create-team'],
pages['create-user'],
],
Interactivity: [
pages['appearance'],
pages['cursor'],
pages['outline'],
pages['pointer-events'],
pages['resize'],
pages['user-select'],
'Advanced tutorial': [
pages['create-variables'],
pages['create-sidemenu'],
pages['advance-permissions'],
pages['alerts'],
pages['advance-dashboard'],
],
SVG: [pages['fill'], pages['stroke'], pages['stroke-width']],
Accessibility: [pages['screen-readers']],
'Official Plugins': [pages['typography-plugin']],
'Developer guide': [
pages['developer-installation'],
]
}
}

Expand Down
22 changes: 9 additions & 13 deletions docs/src/pages/docs-cn/tutorial.mdx
Expand Up @@ -10,20 +10,16 @@ import { TipCompat } from '@/components/Tip'

DataV是一个综合性的数据查询、展示及告警平台,支持Metrics、Logs、Traces等常用数据形式,具有以下主要的功能特性

| 功能 | 描述 |
| Feature | Description |
|:------|:------------:|
| **类似Grafana** | 在核心功能上DataV类似Grafana |
| **图表插件** | 高性能、可扩展、漂亮的图表插件系统,同时支持丰富的选项配置 |
| **动态Dashboard** | 支持自定义Dashboard,同时可以使用模版变量来增强Dashboard的可复用性|
| **酷炫大屏** | 自定义大屏,可以很好满足各种大屏的需求 |
| **Iframe API** | 你可以把DataV的页面嵌入进自己的网站中,我们提供了丰富的API来帮助你更好的iframe |
| **自定义页面菜单导航** | 我的菜单我做主,图表页面可以放在任何菜单导航中,实现更方便的访问和管理 |
| **报表生成** | 只需要勾勾选选,就能快速生成一份强大的报表,同时支持邮件自动推送 |
| **配置导出和导入** | 支持多个级别的配置管理,同时能做到自动备份 |
| **多环境** | 可以自定义多套环境,让你的测试、预发、生产、容器等图表全部在一套系统中展现 |
|**多语言、多主题**|默认支持中/英语言、白天/黑夜主题,同时支持在线自定义主题|
| **优秀的代码**|全部用Typescript + React + Go实现,完善的测试覆盖以及精简的代码实现|

| **插件化** | 高性能,可扩展,美观,可配置 |
| **动态仪表盘** | 使用丰富的配置项来打造强大的动态图表 |
| **可交互图表** | 可以为图表设置鼠标点击事件,来自定义图表交互行为 |
| **数据大屏** | 利用装饰性组件,实现多样化的数据大屏酷炫效果 |
| **告警** | 为指标性数据设置告警阈值,可以精确到曲线级别(Grafana是图表级别) |
| **模版变量** | 本地变量类似grafana,全局变量是多个仪表盘可以共享的变量 |
| **权限控制** | 企业级的权限控制,可以实现用户、团队、仪表盘三个维度的同时控制 |
| **自定义侧边菜单=** | 通过链接仪表盘到侧边菜单项,你可以实现自定义的二级菜单,打造团队的个性化菜单导航 |

## 新手引导
在新手引导中,我们会带你浏览并使用datav的主要功能,若你是第一次使用datav,请花一些时间来完成该新手引导,大概5-10分钟即可。
Expand Down
110 changes: 0 additions & 110 deletions docs/src/pages/docs/adding-base-styles.mdx

This file was deleted.

0 comments on commit c205689

Please sign in to comment.