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

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