Commit efe4200181785dc5425259622b8007e44163750f

Authored by YunaiV
1 parent 5266c6b1

开发环境下,管理后台每个菜单展示对应的《开发文档》的说明

yudao-ui-admin/.env.demo1024
@@ -13,3 +13,9 @@ VUE_APP_BASE_API = 'http://127.0.0.1:48080' @@ -13,3 +13,9 @@ VUE_APP_BASE_API = 'http://127.0.0.1:48080'
13 PUBLIC_PATH = '/admin-ui/' 13 PUBLIC_PATH = '/admin-ui/'
14 # 二级部署路径 14 # 二级部署路径
15 VUE_APP_APP_NAME ='/admin-ui/' 15 VUE_APP_APP_NAME ='/admin-ui/'
  16 +
  17 +# 多租户的开关
  18 +VUE_APP_TENANT_ENABLE = true
  19 +
  20 +# 文档的开关
  21 +VUE_APP_DOC_ENABLE = true
yudao-ui-admin/.env.development
@@ -13,3 +13,6 @@ VUE_CLI_BABEL_TRANSPILE_MODULES = true @@ -13,3 +13,6 @@ VUE_CLI_BABEL_TRANSPILE_MODULES = true
13 13
14 # 多租户的开关 14 # 多租户的开关
15 VUE_APP_TENANT_ENABLE = true 15 VUE_APP_TENANT_ENABLE = true
  16 +
  17 +# 文档的开关
  18 +VUE_APP_DOC_ENABLE = true
yudao-ui-admin/.env.production
@@ -12,3 +12,8 @@ PUBLIC_PATH = 'http://my-pi.com:8888/yudao-admin/' @@ -12,3 +12,8 @@ PUBLIC_PATH = 'http://my-pi.com:8888/yudao-admin/'
12 # 二级部署路径 12 # 二级部署路径
13 VUE_APP_APP_NAME ='yudao-admin' 13 VUE_APP_APP_NAME ='yudao-admin'
14 14
  15 +# 多租户的开关
  16 +VUE_APP_TENANT_ENABLE = true
  17 +
  18 +# 文档的开关
  19 +VUE_APP_DOC_ENABLE = false
yudao-ui-admin/.env.staging
@@ -11,3 +11,9 @@ VUE_APP_BASE_API = 'http://api-dashboard.yudao.iocoder.cn' @@ -11,3 +11,9 @@ VUE_APP_BASE_API = 'http://api-dashboard.yudao.iocoder.cn'
11 11
12 # 静态资源地址 12 # 静态资源地址
13 PUBLIC_PATH = 'http://static.yudao.iocoder.cn/' 13 PUBLIC_PATH = 'http://static.yudao.iocoder.cn/'
  14 +
  15 +# 多租户的开关
  16 +VUE_APP_TENANT_ENABLE = true
  17 +
  18 +# 文档的开关
  19 +VUE_APP_DOC_ENABLE = false
yudao-ui-admin/src/components/DocAlert/index.vue 0 → 100644
  1 +<template>
  2 + <el-alert v-if="enable()" :title="'【' + title + '】文档地址:' + url" type="success" show-icon />
  3 +</template>
  4 +
  5 +<script>
  6 +import {getDocEnable} from "@/utils/ruoyi";
  7 +
  8 +export default {
  9 + name: "DocAlert",
  10 + props: {
  11 + title: String,
  12 + url: String,
  13 + },
  14 + methods: {
  15 + enable: function () {
  16 + return getDocEnable();
  17 + }
  18 + }
  19 +};
  20 +</script>
  21 +<style scoped>
  22 +.el-alert--success.is-light {
  23 + margin-bottom: 10px;
  24 +}
  25 +</style>
yudao-ui-admin/src/main.js
@@ -41,10 +41,12 @@ Vue.prototype.handleTree = handleTree @@ -41,10 +41,12 @@ Vue.prototype.handleTree = handleTree
41 41
42 // 全局组件挂载 42 // 全局组件挂载
43 Vue.component('DictTag', DictTag) 43 Vue.component('DictTag', DictTag)
  44 +Vue.component('DocAlert', DocAlert)
44 Vue.component('Pagination', Pagination) 45 Vue.component('Pagination', Pagination)
45 Vue.component('RightToolbar', RightToolbar) 46 Vue.component('RightToolbar', RightToolbar)
46 // 字典标签组件 47 // 字典标签组件
47 import DictTag from '@/components/DictTag' 48 import DictTag from '@/components/DictTag'
  49 +import DocAlert from '@/components/DocAlert'
48 // 头部标签插件 50 // 头部标签插件
49 import VueMeta from 'vue-meta' 51 import VueMeta from 'vue-meta'
50 52
yudao-ui-admin/src/utils/ruoyi.js
@@ -175,7 +175,7 @@ export function getNowDateTime(timeStr) { @@ -175,7 +175,7 @@ export function getNowDateTime(timeStr) {
175 * 获得租户功能是否开启 175 * 获得租户功能是否开启
176 */ 176 */
177 export function getTenantEnable() { 177 export function getTenantEnable() {
178 - console.log("enable: " + process.env.VUE_APP_TENANT_ENABLE) 178 + // console.log("enable: " + process.env.VUE_APP_TENANT_ENABLE)
179 if (process.env.VUE_APP_TENANT_ENABLE === "true") { 179 if (process.env.VUE_APP_TENANT_ENABLE === "true") {
180 return true; 180 return true;
181 } 181 }
@@ -184,3 +184,16 @@ export function getTenantEnable() { @@ -184,3 +184,16 @@ export function getTenantEnable() {
184 } 184 }
185 return process.env.VUE_APP_TENANT_ENABLE || true; 185 return process.env.VUE_APP_TENANT_ENABLE || true;
186 } 186 }
  187 +
  188 +/**
  189 + * 获得文档是否开启
  190 + */
  191 +export function getDocEnable() {
  192 + if (process.env.VUE_APP_DOC_ENABLE === "true") {
  193 + return true;
  194 + }
  195 + if (process.env.VUE_APP_DOC_ENABLE === "false") {
  196 + return false;
  197 + }
  198 + return process.env.VUE_APP_DOC_ENABLE || false;
  199 +}
yudao-ui-admin/src/views/bpm/definition/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
  4 +
3 <!-- 列表 --> 5 <!-- 列表 -->
4 <el-table v-loading="loading" :data="list"> 6 <el-table v-loading="loading" :data="list">
5 <el-table-column label="定义编号" align="center" prop="id" width="400" /> 7 <el-table-column label="定义编号" align="center" prop="id" width="400" />
yudao-ui-admin/src/views/bpm/form/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/group/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/model/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/oa/leave/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/processInstance/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/task/done.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/bpm/task/todo.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="工作流" url="https://doc.iocoder.cn/bpm" />
3 4
4 <!-- 搜索工作栏 --> 5 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 6 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
yudao-ui-admin/src/views/infra/codegen/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="代码生成" url="https://doc.iocoder.cn/new-feature/" />
3 <!-- 操作工作栏 --> 4 <!-- 操作工作栏 -->
4 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
5 <el-form-item label="表名称" prop="tableName"> 6 <el-form-item label="表名称" prop="tableName">
yudao-ui-admin/src/views/infra/file/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
3 - 3 + <doc-alert title="上传下载" url="https://doc.iocoder.cn/file/" />
4 <!-- 搜索工作栏 --> 4 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
6 <el-form-item label="文件路径" prop="path"> 6 <el-form-item label="文件路径" prop="path">
yudao-ui-admin/src/views/infra/fileConfig/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
3 - 3 + <doc-alert title="上传下载" url="https://doc.iocoder.cn/file/" />
4 <!-- 搜索工作栏 --> 4 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
6 <el-form-item label="配置名" prop="name"> 6 <el-form-item label="配置名" prop="name">
yudao-ui-admin/src/views/system/menu/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="功能权限" url="https://doc.iocoder.cn/resource-permission" />
3 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch"> 4 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch">
4 <el-form-item label="菜单名称" prop="name"> 5 <el-form-item label="菜单名称" prop="name">
5 <el-input v-model="queryParams.name" placeholder="请输入菜单名称" clearable size="small" @keyup.enter.native="handleQuery"/> 6 <el-input v-model="queryParams.name" placeholder="请输入菜单名称" clearable size="small" @keyup.enter.native="handleQuery"/>
yudao-ui-admin/src/views/system/role/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
  3 + <doc-alert title="功能权限" url="https://doc.iocoder.cn/resource-permission" />
  4 + <doc-alert title="数据权限" url="https://doc.iocoder.cn/data-permission" />
3 <el-form :model="queryParams" ref="queryForm" v-show="showSearch" :inline="true"> 5 <el-form :model="queryParams" ref="queryForm" v-show="showSearch" :inline="true">
4 <el-form-item label="角色名称" prop="name"> 6 <el-form-item label="角色名称" prop="name">
5 <el-input v-model="queryParams.name" placeholder="请输入角色名称" clearable size="small" style="width: 240px" 7 <el-input v-model="queryParams.name" placeholder="请输入角色名称" clearable size="small" style="width: 240px"
yudao-ui-admin/src/views/system/tenant/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
3 - 3 + <doc-alert title="SaaS 多租户" url="https://doc.iocoder.cn/saas-tenant/" />
4 <!-- 搜索工作栏 --> 4 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
6 <el-form-item label="租户名" prop="name"> 6 <el-form-item label="租户名" prop="name">
yudao-ui-admin/src/views/system/tenantPackage/index.vue
1 <template> 1 <template>
2 <div class="app-container"> 2 <div class="app-container">
3 - 3 + <doc-alert title="SaaS 多租户" url="https://doc.iocoder.cn/saas-tenant/" />
4 <!-- 搜索工作栏 --> 4 <!-- 搜索工作栏 -->
5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px"> 5 <el-form :model="queryParams" ref="queryForm" :inline="true" v-show="showSearch" label-width="68px">
6 <el-form-item label="套餐名" prop="name"> 6 <el-form-item label="套餐名" prop="name">