Skip to content

Commit

Permalink
docs: 更新 README 地址
Browse files Browse the repository at this point in the history
  • Loading branch information
cdk8s-zelda committed Aug 27, 2019
1 parent 08edaf7 commit 8c0f9bd
Showing 1 changed file with 42 additions and 26 deletions.
68 changes: 42 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,62 +60,76 @@

## Documentation

- 我们统一了 TKey 项目的所有文档,方便大家查看
- Github:<https://github.com/cdk8s/tkey-docs>
- Gitee:<https://gitee.com/cdk8s/tkey-docs>
- Gitbook:<https://160668873.gitbook.io/tkey-docs/>
- **认识阶段 (必读)**
- [单点登录系统认知与基础介绍](https://github.com/cdk8s/tkey-docs/blob/master/other/tkey-baisc.md)
- [故意设计点(常见问题)](https://github.com/cdk8s/tkey-docs/blob/master/faq/README.md)
- [项目结构与端口占用](https://github.com/cdk8s/tkey-docs/blob/master/other/project-structure.md)
- [OAuth2.0 四种模式](https://github.com/cdk8s/tkey-docs/blob/master/server/oauth-grant-type/README.md)
- [JAR 方式部署](https://github.com/cdk8s/tkey-docs/blob/master/deployment/jar-runapp.md)
- [Docker 方式部署](https://github.com/cdk8s/tkey-docs/blob/master/deployment/docker-runapp.md)
- [Docker Compose 方式部署](https://github.com/cdk8s/tkey-docs/blob/master/deployment/docker-compose-runapp.md)
- 单点登录系统认知与基础介绍[Github](https://github.com/cdk8s/tkey-docs/blob/master/other/tkey-baisc.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/other/tkey-baisc.md)
- 故意设计点(常见问题)[Github](https://github.com/cdk8s/tkey-docs/blob/master/faq/README.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/faq/README.md)
- 项目结构与端口占用[Github](https://github.com/cdk8s/tkey-docs/blob/master/other/project-structure.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/other/project-structure.md)
- OAuth2.0 四种模式[Github](https://github.com/cdk8s/tkey-docs/blob/master/server/oauth-grant-type/README.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/server/oauth-grant-type/README.md)
- JAR 方式部署[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/jar-runapp.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/jar-runapp.md)
- Docker 方式部署[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/docker-runapp.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/docker-runapp.md)
- Docker Compose 方式部署[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/docker-compose-runapp.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/docker-compose-runapp.md)
- TKey Server 开发阶段
- [开发改造引导](https://github.com/cdk8s/tkey-docs/blob/master/server/dev.md)
- 开发改造引导[Github](https://github.com/cdk8s/tkey-docs/blob/master/server/dev.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/server/dev.md)
- TKey Management 开发阶段(也是前后端分离的最佳实践示例)
- [后端开发改造引导](https://github.com/cdk8s/tkey-docs/blob/master/management/dev-backend.md)
- [前端开发改造引导](https://github.com/cdk8s/tkey-docs/blob/master/management/dev-frontend.md)
- 后端开发改造引导[Github](https://github.com/cdk8s/tkey-docs/blob/master/management/dev-backend.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/management/dev-backend.md)
- 前端开发改造引导[Github](https://github.com/cdk8s/tkey-docs/blob/master/management/dev-frontend.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/management/dev-frontend.md)
- TKey Client Java 开发阶段
- [自己封装的 REST Client](https://github.com/cdk8s/tkey-docs/blob/master/client/dev-rest-client.md)
- [Spring Security 支持](https://github.com/cdk8s/tkey-docs/blob/master/client/dev-spring-security-client.md)
- 自己封装的 REST Client[Github](https://github.com/cdk8s/tkey-docs/blob/master/client/dev-rest-client.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/client/dev-rest-client.md)
- Spring Security 支持[Github](https://github.com/cdk8s/tkey-docs/blob/master/client/dev-spring-security-client.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/client/dev-spring-security-client.md)
- 测试阶段
- [单元测试](https://github.com/cdk8s/tkey/blob/master/src/test/java/com/cdk8s/tkey/server/controller/AuthorizationCodeByFormTest.java)
- [压力测试](https://github.com/cdk8s/tkey-docs/blob/master/test/performance.md)
- 单元测试[Github](https://github.com/cdk8s/tkey/blob/master/src/test/java/com/cdk8s/tkey/server/controller/AuthorizationCodeByFormTest.java)[Gitee](https://gitee.com/cdk8s/tkey/blob/master/src/test/java/com/cdk8s/tkey/server/controller/AuthorizationCodeByFormTest.java)
- 压力测试[Github](https://github.com/cdk8s/tkey-docs/blob/master/test/performance.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/test/performance.md)
- 部署阶段
- [生产注意事项](https://github.com/cdk8s/tkey-docs/blob/master/deployment/production-environment.md)
- [部署环境搭建](https://github.com/cdk8s/tkey-docs/blob/master/deployment/deployment-core.md)
- 生产注意事项[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/production-environment.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/production-environment.md)
- 部署环境搭建[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/deployment-core.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/deployment-core.md)
- 监控阶段
- [Spring Boot Micrometer](https://github.com/cdk8s/tkey-docs/blob/master/deployment/micrometer.md)
- Spring Boot Micrometer[Github](https://github.com/cdk8s/tkey-docs/blob/master/deployment/micrometer.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/deployment/micrometer.md)
- 其他工具全在 `部署环境搭建`,请自行查看
- 线上问题诊断
- [Actuator 在线修改 log 输出级别(Gif 动图)](http://img.gitnavi.com/tkey/actuator-update-log-level.gif)
- [Arthas 诊断 Docker 应用](https://alibaba.github.io/arthas/docker.html#dockerjava)
- [夜间开放端口,挑选流量远程 Debug](https://github.com/cdk8s/tkey-docs/blob/master/server/remote-debug.md)
- 夜间开放端口,挑选流量远程 Debug[Github](https://github.com/cdk8s/tkey-docs/blob/master/server/remote-debug.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/server/remote-debug.md)


## TKey Client

- Java 前后端分离
- [(React)]()
- Java 前后端分离最佳实践
- TKey SSO Client Management Backend:[Github](https://github.com/cdk8s/tkey-management)[Gitee](https://gitee.com/cdk8s/tkey-management)
- TKey SSO Client Management Frontend:[Github](https://github.com/cdk8s/tkey-management-frontend)[Gitee](https://gitee.com/cdk8s/tkey-management)
- Angular、Vue 的前后端分离版本会在稍后几周发出来
- Java 非前后端分离
- Java REST API 客户端:[Github](https://github.com/cdk8s/tkey-client-java)[Gitee](https://gitee.com/cdk8s/tkey-client-java)
- Java Spring Security 客户端:[Github](https://github.com/cdk8s/tkey-client-java-spring-security)[Gitee](https://gitee.com/cdk8s/tkey-client-java-spring-security)
- C#(暂缺)
- GO(暂缺)
- PHP(暂缺)
- Python(暂缺)
- Ruby(暂缺)
- Node.js(暂缺)

## Share

- Grafana Dashboard:[Github](https://github.com/cdk8s/tkey-docs/blob/master/share-file/grafana/dashboard.json)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/share-file/grafana/dashboard.json)
- Postman API:[Github](https://github.com/cdk8s/tkey-docs/blob/master/share-file/postman/tkey-sso-server-api_collection_2.1_format.json)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/share-file/postman/tkey-sso-server-api_collection_2.1_format.json)
- Run JAR Shell:[Github](https://github.com/cdk8s/tkey-docs/blob/master/share-file/shell/runapp.sh)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/share-file/shell/runapp.sh)


## Roadmap

- [规划版本](https://github.com/cdk8s/tkey-docs/blob/master/roadmap/README.md)
- 规划版本[Github](https://github.com/cdk8s/tkey-docs/blob/master/roadmap/README.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/roadmap/README.md)

## Changelog

- [版本更新](https://github.com/cdk8s/tkey-docs/blob/master/changelog/README.md)
- 版本更新:[Github](https://github.com/cdk8s/tkey-docs/blob/master/changelog/README.md)[Gitee](https://gitee.com/cdk8s/tkey-docs/blob/master/changelog/README.md)


## Issues

- [去提问](https://github.com/cdk8s/tkey-issues/issues)
- 目前只开放了一个 issues 入口,集中问题,可以方便大家检索。
- 去提问:[Github](https://github.com/cdk8s/tkey-issues)[Gitee](https://gitee.com/cdk8s/tkey-issues)

## Contributors

Expand All @@ -124,7 +138,7 @@

## Adopters

- [去申请](https://github.com/cdk8s/tkey-issues/issues/1)
- 去申请[Github](https://github.com/cdk8s/tkey-issues/issues/1)[Gitee](https://gitee.com/cdk8s/tkey-issues/issues/1)

## Sponsors

Expand Down Expand Up @@ -164,4 +178,6 @@

- Copyright (c) CDK8S. All rights reserved.
- Licensed under the **MIT** license.
- **再次强调: 因为是 MIT 协议,大家有不满意的,除了 PR 也可以 fork 后自己尽情改造!**
- **再次强调: 因为是 MIT 协议,大家有不满意的,除了 PR 也可以 fork 后自己尽情改造!**


0 comments on commit 8c0f9bd

Please sign in to comment.