From 3d47e5cf4d799c1105c1566d25570471d23d843d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=87=91=E6=88=9F?= Date: Sun, 26 Jan 2020 14:56:23 +0800 Subject: [PATCH] move docs file out of dash naming folder --- README.md | 8 ++++---- docs/_media/guide/.DS_Store | Bin 6148 -> 0 bytes docs/coverpage.md | 2 +- docs/en-us/{_coverpage.md => coverpage.md} | 2 +- docs/en-us/guide/dashboard.md | 2 +- docs/en-us/guide/how-to-use-in-idea.md | 4 ++-- docs/en-us/guide/localdev.md | 4 ++-- docs/en-us/guide/mesh.md | 10 +++++----- docs/index.html | 1 + docs/{_media => media}/arch.png | Bin docs/{_media => media}/bg.png | Bin docs/{_media => media}/dashboard-demo.png | Bin docs/{_media => media}/demo-1.gif | Bin docs/{_media => media}/demo-2.gif | Bin docs/{_media => media}/demo-3.gif | Bin docs/{_media => media}/dingtalk-group.png | Bin docs/{_media => media}/guide/demo-tomcat-7.png | Bin docs/{_media => media}/guide/demo-tomcat-8.png | Bin docs/{_media => media}/guide/demo-user-agent.png | Bin .../guide/idea_run_application.png | Bin .../guide/install_idea_plugin.png | Bin docs/{_media => media}/guide/kt-dashboard.png | Bin docs/{_media => media}/guide/local-dev-01.png | Bin docs/{_media => media}/guide/local-dev-02.png | Bin docs/{_media => media}/logo-large.png | Bin docs/{_media => media}/logo.png | Bin docs/zh-cn/{_coverpage.md => coverpage.md} | 2 +- docs/zh-cn/guide/dashboard.md | 2 +- docs/zh-cn/guide/how-to-use-in-idea.md | 4 ++-- docs/zh-cn/guide/localdev.md | 4 ++-- docs/zh-cn/guide/mesh.md | 10 +++++----- 31 files changed, 28 insertions(+), 27 deletions(-) delete mode 100644 docs/_media/guide/.DS_Store rename docs/en-us/{_coverpage.md => coverpage.md} (94%) rename docs/{_media => media}/arch.png (100%) rename docs/{_media => media}/bg.png (100%) rename docs/{_media => media}/dashboard-demo.png (100%) rename docs/{_media => media}/demo-1.gif (100%) rename docs/{_media => media}/demo-2.gif (100%) rename docs/{_media => media}/demo-3.gif (100%) rename docs/{_media => media}/dingtalk-group.png (100%) rename docs/{_media => media}/guide/demo-tomcat-7.png (100%) rename docs/{_media => media}/guide/demo-tomcat-8.png (100%) rename docs/{_media => media}/guide/demo-user-agent.png (100%) rename docs/{_media => media}/guide/idea_run_application.png (100%) rename docs/{_media => media}/guide/install_idea_plugin.png (100%) rename docs/{_media => media}/guide/kt-dashboard.png (100%) rename docs/{_media => media}/guide/local-dev-01.png (100%) rename docs/{_media => media}/guide/local-dev-02.png (100%) rename docs/{_media => media}/logo-large.png (100%) rename docs/{_media => media}/logo.png (100%) rename docs/zh-cn/{_coverpage.md => coverpage.md} (87%) diff --git a/README.md b/README.md index 4fc8657..017d000 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ KT Connect [![Build Status](https://travis-ci.org/alibaba/kt-connect.svg?branch=master)](https://travis-ci.org/alibaba/kt-connect) ![License](https://img.shields.io/github/license/alibaba/kt-connect.svg) -![Logo](./docs/_media/logo.png) +![Logo](./docs/media/logo.png) Management and Integration with your Kubernetes dev environment more efficient. -![Arch](./docs/_media/arch.png) +![Arch](./docs/media/arch.png) ## Features @@ -134,7 +134,7 @@ SSH Remote port-forward POD 172.16.0.217 22 to 127.0.0.1:2217 starting Dashboard can help your know how your dev environemnt is used. -![Dashboard](./docs/_media/dashboard-demo.png) +![Dashboard](./docs/media/dashboard-demo.png) You can install KT Connect Dashboard As Follow [Install Dashboard](https://rdc-incubator.github.io/kt-docs/#/guide/dashboard) @@ -168,7 +168,7 @@ GOARCH=amd64 GOOS=linux go build -o bin/proxy cmd/shadow/main.go Please contact me with DingTalk: -![image](./docs/_media/dingtalk-group.png) +![image](./docs/media/dingtalk-group.png) ## Release Note diff --git a/docs/_media/guide/.DS_Store b/docs/_media/guide/.DS_Store deleted file mode 100644 index 5008ddfcf53c02e82d7eee2e57c38e5672ef89f6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeH~Jr2S!425mzP>H1@V-^m;4Wg<&0T*E43hX&L&p$$qDprKhvt+--jT7}7np#A3 zem<@ulZcFPQ@L2!n>{z**++&mCkOWA81W14cNZlEfg7;MkzE(HCqgga^y>{tEnwC%0;vJ&^%eQ zLs35+`xjp>T0 + # KT Connect0.0.9 diff --git a/docs/en-us/_coverpage.md b/docs/en-us/coverpage.md similarity index 94% rename from docs/en-us/_coverpage.md rename to docs/en-us/coverpage.md index bfe0d6d..f972c65 100644 --- a/docs/en-us/_coverpage.md +++ b/docs/en-us/coverpage.md @@ -1,4 +1,4 @@ - + # KT Connect0.0.9 diff --git a/docs/en-us/guide/dashboard.md b/docs/en-us/guide/dashboard.md index efdb73e..eecc31b 100644 --- a/docs/en-us/guide/dashboard.md +++ b/docs/en-us/guide/dashboard.md @@ -5,7 +5,7 @@ Dashboard KT Connect Dashboard support visualization your test environment status, as follow: -![](../../_media/guide/kt-dashboard.png) +![](../../media/guide/kt-dashboard.png) Current support features as follow: diff --git a/docs/en-us/guide/how-to-use-in-idea.md b/docs/en-us/guide/how-to-use-in-idea.md index b550700..1a64700 100644 --- a/docs/en-us/guide/how-to-use-in-idea.md +++ b/docs/en-us/guide/how-to-use-in-idea.md @@ -25,11 +25,11 @@ This command will create .jvmrc that includes all JVM ops should apply to Java a Download and Install the lastest version of [JVM Inject](https://plugins.jetbrains.com/plugin/13482-jvm-inject/versions)插件 -![Instll Plugin](../../_media/guide/install_idea_plugin.png) +![Instll Plugin](../../media/guide/install_idea_plugin.png) JVM Inject Plugin will auto read the .jvmrc content from workspace. if present it will append all content to Idea Java Launcher: -![Run Application](../../_media/guide/idea_run_application.png) +![Run Application](../../media/guide/idea_run_application.png) ``` java ...ignore content... -Djava.rmi.server.hostname=127.0.0.1 -Dspring.liveBeansView.mbeanDomain -Dspring.application.admin.enabled=true -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=2223 "-javaagent:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=58609:/Applications/IntelliJ IDEA.app/Contents/bin" ...ignore content... sample.Application diff --git a/docs/en-us/guide/localdev.md b/docs/en-us/guide/localdev.md index dde4632..506dda0 100644 --- a/docs/en-us/guide/localdev.md +++ b/docs/en-us/guide/localdev.md @@ -9,7 +9,7 @@ However, in general, the container network used by Kubernetes is not directly co In order to enable developers to deploy modified code to the cluster test environment more quickly, we will generally introduce a continuous delivery pipeline, which will solve the problem of code compilation, image packaging upload and deployment through automation. As follows: -![](../../_media/guide/local-dev-01.png) +![](../../media/guide/local-dev-01.png) To a certain extent, this approach can avoid developers doing a lot of repetitive work. However, although the entire process is automated, developers also have to wait for the pipeline to run after each code change. For developers, waiting for the pipeline to run after each code change may have become the worst part of the entire development task. @@ -21,7 +21,7 @@ Ideally, the developer can start the service directly locally, and the service c - I rely on other services: the code running locally can access other applications deployed in the cluster directly through the podIP, clusterIP or even the DNS address in the Kubernetes cluster, as shown below; - Other services depend on me: other applications running in the Kubernetes cluster can access my running local code without any changes, as shown below: -![](../../_media/guide/local-dev-02.png) +![](../../media/guide/local-dev-02.png) To achieve the two local joint adjustment methods just mentioned, we mainly need to solve the following three problems.： diff --git a/docs/en-us/guide/mesh.md b/docs/en-us/guide/mesh.md index 232cf7f..54b4217 100644 --- a/docs/en-us/guide/mesh.md +++ b/docs/en-us/guide/mesh.md @@ -9,7 +9,7 @@ The main solution of `Mesh` is that if the team shares a development test enviro `Mesh` is similar to `Exchange`. The difference is that Exchange will completely replace the original application instance, while Mesh creates a new version based on the original instance, thus enabling users to do more based on Service Mesh capabilities. Multiple custom traffic rule definitions. This enables team members to perform local joint testing on a common development test environment. -![logo](../../_media/logo-large.png) +![logo](../../media/logo-large.png) ## Demo: @@ -155,7 +155,7 @@ Add custom DNS in the local Hosts: 通过域名`http://tomcat.mesh.com`访问实例应用: -![](../../_media/guide/demo-tomcat-7.png) +![](../../media/guide/demo-tomcat-7.png) ### Mesh： adds a local access endpoint @@ -231,12 +231,12 @@ spec: At this point, if you access the service through the Firefox browser, you can access the local Tomcat: 8 instance: -![](../../_media/guide/demo-tomcat-8.png) +![](../../media/guide/demo-tomcat-8.png) Accessing the application through a non-Firefox browser will give you access to the original Tomcat:7 application: -![](../../_media/guide/demo-tomcat-7.png) +![](../../media/guide/demo-tomcat-7.png) Note: User-agent can be viewed through Firefox's browser development tool as follows: -![](../../_media/guide/demo-user-agent.png) \ No newline at end of file +![](../../media/guide/demo-user-agent.png) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b8b5d58..f2f1266 100644 --- a/docs/index.html +++ b/docs/index.html @@ -18,6 +18,7 @@ name: 'Kt Connect Docs', loadSidebar: "sidebar.md", loadNavbar: "navbar.md", + coverpage: "coverpage.md", mergeNavbar: true, homepage: '/en-us/README.md', plugins: [ diff --git a/docs/_media/arch.png b/docs/media/arch.png similarity index 100% rename from docs/_media/arch.png rename to docs/media/arch.png diff --git a/docs/_media/bg.png b/docs/media/bg.png similarity index 100% rename from docs/_media/bg.png rename to docs/media/bg.png diff --git a/docs/_media/dashboard-demo.png b/docs/media/dashboard-demo.png similarity index 100% rename from docs/_media/dashboard-demo.png rename to docs/media/dashboard-demo.png diff --git a/docs/_media/demo-1.gif b/docs/media/demo-1.gif similarity index 100% rename from docs/_media/demo-1.gif rename to docs/media/demo-1.gif diff --git a/docs/_media/demo-2.gif b/docs/media/demo-2.gif similarity index 100% rename from docs/_media/demo-2.gif rename to docs/media/demo-2.gif diff --git a/docs/_media/demo-3.gif b/docs/media/demo-3.gif similarity index 100% rename from docs/_media/demo-3.gif rename to docs/media/demo-3.gif diff --git a/docs/_media/dingtalk-group.png b/docs/media/dingtalk-group.png similarity index 100% rename from docs/_media/dingtalk-group.png rename to docs/media/dingtalk-group.png diff --git a/docs/_media/guide/demo-tomcat-7.png b/docs/media/guide/demo-tomcat-7.png similarity index 100% rename from docs/_media/guide/demo-tomcat-7.png rename to docs/media/guide/demo-tomcat-7.png diff --git a/docs/_media/guide/demo-tomcat-8.png b/docs/media/guide/demo-tomcat-8.png similarity index 100% rename from docs/_media/guide/demo-tomcat-8.png rename to docs/media/guide/demo-tomcat-8.png diff --git a/docs/_media/guide/demo-user-agent.png b/docs/media/guide/demo-user-agent.png similarity index 100% rename from docs/_media/guide/demo-user-agent.png rename to docs/media/guide/demo-user-agent.png diff --git a/docs/_media/guide/idea_run_application.png b/docs/media/guide/idea_run_application.png similarity index 100% rename from docs/_media/guide/idea_run_application.png rename to docs/media/guide/idea_run_application.png diff --git a/docs/_media/guide/install_idea_plugin.png b/docs/media/guide/install_idea_plugin.png similarity index 100% rename from docs/_media/guide/install_idea_plugin.png rename to docs/media/guide/install_idea_plugin.png diff --git a/docs/_media/guide/kt-dashboard.png b/docs/media/guide/kt-dashboard.png similarity index 100% rename from docs/_media/guide/kt-dashboard.png rename to docs/media/guide/kt-dashboard.png diff --git a/docs/_media/guide/local-dev-01.png b/docs/media/guide/local-dev-01.png similarity index 100% rename from docs/_media/guide/local-dev-01.png rename to docs/media/guide/local-dev-01.png diff --git a/docs/_media/guide/local-dev-02.png b/docs/media/guide/local-dev-02.png similarity index 100% rename from docs/_media/guide/local-dev-02.png rename to docs/media/guide/local-dev-02.png diff --git a/docs/_media/logo-large.png b/docs/media/logo-large.png similarity index 100% rename from docs/_media/logo-large.png rename to docs/media/logo-large.png diff --git a/docs/_media/logo.png b/docs/media/logo.png similarity index 100% rename from docs/_media/logo.png rename to docs/media/logo.png diff --git a/docs/zh-cn/_coverpage.md b/docs/zh-cn/coverpage.md similarity index 87% rename from docs/zh-cn/_coverpage.md rename to docs/zh-cn/coverpage.md index 82a7961..cb40576 100644 --- a/docs/zh-cn/_coverpage.md +++ b/docs/zh-cn/coverpage.md @@ -1,4 +1,4 @@ -![logo](../_media/logo.png) +![logo](../media/logo.png) # KT Connect0.0.9 diff --git a/docs/zh-cn/guide/dashboard.md b/docs/zh-cn/guide/dashboard.md index 9c22435..020500b 100644 --- a/docs/zh-cn/guide/dashboard.md +++ b/docs/zh-cn/guide/dashboard.md @@ -5,7 +5,7 @@ Dashboard KT Connect 提供了一个可视化控制台用于查看和管理测试环境的整体状态。如下所示： -![](../../_media/guide/kt-dashboard.png) +![](../../media/guide/kt-dashboard.png) 目前Dashboard提供的主要功能包括： diff --git a/docs/zh-cn/guide/how-to-use-in-idea.md b/docs/zh-cn/guide/how-to-use-in-idea.md index 45353cf..40f781e 100644 --- a/docs/zh-cn/guide/how-to-use-in-idea.md +++ b/docs/zh-cn/guide/how-to-use-in-idea.md @@ -25,11 +25,11 @@ sudo ktctl -d connect --method=socks5 下载并安装最新版本的[JVM Inject](https://plugins.jetbrains.com/plugin/13482-jvm-inject/versions)插件 -![安装插件](../../_media/guide/install_idea_plugin.png) +![安装插件](../../media/guide/install_idea_plugin.png) JVM Inject插件会在Java程序启动时自动读取.jvmrc文件，并追加到程序的启动参数中，如下所示: -![安装插件](../../_media/guide/idea_run_application.png) +![安装插件](../../media/guide/idea_run_application.png) ``` java ...省略的其他输出... -Djava.rmi.server.hostname=127.0.0.1 -Dspring.liveBeansView.mbeanDomain -Dspring.application.admin.enabled=true -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=2223 "-javaagent:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=58609:/Applications/IntelliJ IDEA.app/Contents/bin" ...省略的其他输出... sample.Application diff --git a/docs/zh-cn/guide/localdev.md b/docs/zh-cn/guide/localdev.md index 4dc55f9..b1ce5a0 100644 --- a/docs/zh-cn/guide/localdev.md +++ b/docs/zh-cn/guide/localdev.md @@ -9,7 +9,7 @@ 为了能够让开发者能够更快的将修改的代码部署到集群测试环境中，一般来说我们会引入持续交付流水线，将代码的编译，镜像的打包上传以及部署通过自动化的方式来解决。如下所示： -![](../../_media/guide/local-dev-01.png) +![](../../media/guide/local-dev-01.png) 从一定程度上来说，这种方式可以避免开发人员进行大量重复性的工作。但是，虽然整个过程自动化了，但是开发人员也不得不每次进行代码变更之后都需要等待流水线的运行。对于开发人员来说，每次代码变更后等待流水线运行或许已经成为整个开发任务过程中体验最糟糕的部分。 @@ -21,7 +21,7 @@ 我依赖了其它的服务：运行在本地的代码可以直接通过podIP，clusterIP甚至是Kubernetes集群内的DNS地址访问到部署在集群中的其它应用，如下图左； 其它的服务依赖了我：运行在Kubernetes集群中的其它应用可以在不做任何改变的情况下访问我到运行的本地的代码，如下图右: -![](../../_media/guide/local-dev-02.png) +![](../../media/guide/local-dev-02.png) 要实现刚才说的两种本地联调方式，主要需要解决以下3个问题： diff --git a/docs/zh-cn/guide/mesh.md b/docs/zh-cn/guide/mesh.md index 125f8f9..3a85074 100644 --- a/docs/zh-cn/guide/mesh.md +++ b/docs/zh-cn/guide/mesh.md @@ -9,7 +9,7 @@ Mesh： 基于服务网格的开发测试 `Mesh`与`Exchange`的功能类似，差别在于Exchange会完全替换原有的应用实例，而Mesh则是在原有实例的基础上创建一个新的版本，从而支持用户可以基于Service Mesh的能力做更多自定义的流量规则定义。从而实现团队成员在一套公共开发测试环境上完成本地的联调测试。 -![logo](../../_media/logo-large.png) +![logo](../../media/logo-large.png) ## 最佳实践示例： @@ -155,7 +155,7 @@ export INGRESS_PORT=$(kubectl -n istio-system get service istio-ingressgateway - 通过域名`http://tomcat.mesh.com`访问实例应用: -![](../../_media/guide/demo-tomcat-7.png) +![](../../media/guide/demo-tomcat-7.png) ### Mesh添加本地访问端点 @@ -231,12 +231,12 @@ spec: 此时，如果通过Firefox浏览器访问服务，则可以访问到本地Tomcat:8实例: -![](../../_media/guide/demo-tomcat-8.png) +![](../../media/guide/demo-tomcat-8.png) 而通过非Firefox浏览器访问应用则能正常访问到原有的Tomcat:7应用。 -![](../../_media/guide/demo-tomcat-7.png) +![](../../media/guide/demo-tomcat-7.png) 备注：user-agent的可以通过Firefox的浏览器开发工具查看，如下所示： -![](../../_media/guide/demo-user-agent.png) \ No newline at end of file +![](../../media/guide/demo-user-agent.png) \ No newline at end of file