Skip to content

Commit

Permalink
document update
Browse files Browse the repository at this point in the history
  • Loading branch information
sreworks committed Apr 17, 2022
1 parent e82e703 commit d903f18
Show file tree
Hide file tree
Showing 9 changed files with 134 additions and 15 deletions.
Empty file removed CONTRIBUTING-CN.md
Empty file.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,42 @@
# CONTRIBUTING Guide

SREWorks is a community-driven open source project and we welcome any contributor. Contributions to the SREWorks are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).

## 1. Reporting security issues

As our usual principle, we discourage anyone to spread security issues. If you find a security issue of SREWorks, please do not discuss it in public and even do not open a public issue. Instead, we encourage you to send us a private email to dataops@service.alibaba.com to report this.

## 2. Reporting general issues

As a SREWorks user, we welcome your feedback on any questions. Of course, you can also check whether there are similar issues in the current issue list before feedback, and if so, you can add comments under that issue.
There are a lot of cases when you could open an issue:
- API error
- performance issues
- doc incomplete
- usage issues
- feature proposal
- and so on

## 3. Code contribution

Any problem in the code, you can submit a Pull Request to participate, including and not limited to the following scenarios:
- typo
- document incorrect
- redundant code
- ugly code
- feature Enhancement
- performance optimization
- and so on

## 4. Best practices contribution

SREWorks is a cloud-native operation platform center that we expect to support as many cases as possible. If you have a best practice based on SREWorks implementation, you can directly email us dataops@service.alibaba.com tell us or submit an issue. We use the SREWorks platform to promote your best practices.
Best practices include and are not limited to the following:
- an operation and maintenance solution for an open source software
- Integrate the data operation and maintenance practices of some open source software

## 5. Operations and maintenance application contribution

SREWorks supports users to develop various O & M applications. If you feel that the O & M applications you develop can be used in more places, we recommend that you submit your O & M applications to the public application market. (The public market function is still in preparation, you can submit it by mail dataops@service.alibaba.com first)


6 changes: 5 additions & 1 deletion README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ SREWorks 作为阿里云大数据SRE团队对SRE理念的工程实践,专注
- [快速安装](/paas/sw-frontend/docs/documents/rr5g10.md)
- [源码安装](/paas/sw-frontend/docs/documents/mzz07m.md)

## 路线图

[版本记录](/paas/sw-frontend/docs/documents/ogxnmx.md)

## 贡献

[如何参与SREWorks开源](CONTRIBUTING-CN.md)
[如何参与SREWorks开源](/paas/sw-frontned/docs/documents/yc64sk.md)

## 联系我们

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ In the traditional IT O & M field, there are a large number of excellent open so
- [Quick Install](/paas/sw-frontend/docs/documents/rr5g10.md)
- [Install from Source](/paas/sw-frontend/docs/documents/mzz07m.md)

## Roadmap

[ROADMAP](ROADMAP.md)

## Contributing

Check out [CONTRIBUTING](CONTRIBUTING.md) to see how to develop with SREWorks.
Expand Down
5 changes: 0 additions & 5 deletions ROADMAP-CN.md

This file was deleted.

16 changes: 15 additions & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# SREWorks Roadmap

English | [中文](ROADMAP-CN.md)
## SREWorks v1.0 (2022/3/22 Relased)

- Provides a complete cloud-native O & M development and delivery experience
- Operation and maintenance data platform and Operation intelligence platform based on popular open source software in the industry
- Provide mid-level O & M services, including job scheduling, health management, and operation centers.

## SREWorks v1.1

- Provides two installation modes: Basic Edition and Data Intelligence Edition to further reduce the minimum resource deployment limit
- MySQL/es/Minio/Kafka components are compatible with external plug-in
- Front-end editor supports page template saving and using

## SREWorks v1.2

- ChatOps Robot Basic Framework Integration
- Application/Plugin market

20 changes: 18 additions & 2 deletions paas/sw-frontend/docs/documents/ogxnmx.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# 1.5 版本记录

<a name="p6i5l"></a>
### SREWorks V1.0版本特性
提供完整的云原生化运维开发及交付体验<br />基于业界流行开源软件构筑的运维数据平台及运维智能平台<br />提供中台化的运维服务,包括作业调度、健康管理、运营中心等能力
### SREWorks v1.0 (2022/3/22 已发布)
- 提供完整的云原生化运维开发及交付体验
- 基于业界流行开源软件构筑的运维数据平台及运维智能平台
- 提供中台化的运维服务,包括作业调度、健康管理、运营中心等能力

<a name="SPAql"></a>
### SREWorks v1.1

- 提供基础版/数智版两种安装模式,进一步减少在最小资源部署限制
- mysql/es/minio/kafka 组件兼容外部插拔
- 前端编辑器支持页面模板保存和使用

<a name="bC9In"></a>
### SREWorks v1.2

- ChatOps机器人基础框架集成
- 应用/插件市场

52 changes: 46 additions & 6 deletions paas/sw-frontend/docs/documents/yc64sk.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,54 @@
# 7.2 参与SREWorks开源

当前SREWorks开源在Github Alibaba 组织下,欢迎大家加入到SREWorks的开源社区建设中来!

<a name="lGB4U"></a>
### 1,提交Issue
在GitHub Alibaba SREWorks仓库下 [https://github.com/alibaba/SREWorks/issues](https://github.com/alibaba/SREWorks/issues) 可以提交Issue,会有相关同学跟进您的Issue处理。
当前SREWorks项目开源在Github Alibaba 组织下,欢迎大家加入到SREWorks的云原生开源生态建设中来!

<a name="xlQwY"></a>
### 1. 反馈安全问题

我们的原则上不鼓励扩散传播安全问题。如果您发现一个SREWorks的安全问题,请勿公开讨论或开Issue,希望您能够发邮件至 [dataops@service.alibaba.com](mailto:dataops@service.alibaba.com) 反馈这一问题。

<a name="GAFnS"></a>
### 2. 反馈普通问题

您作为一个SREWorks的用户,我们欢迎您反馈任何问题。当然,您在反馈之前也可以看一下当前的[问题列表](https://github.com/alibaba/SREWorks/issues?q=is%3Aissue)中是否已经有类似的问题,如果有可以在那个问题下增加评论。<br />如果您遇到下列的情形,均建议您进行反馈:

- 接口报错
- 性能问题
- 文档不完整
- 使用问题
- 功能建议
- 等等
<a name="vATyu"></a>
###
<a name="DZqml"></a>
### 4. 贡献代码

代码中的任何问题,您都可以提交[Pull Request](https://github.com/alibaba/SREWorks/compare)来参与,包含且不局限于如下场景:

- 代码拼写错误
- 文档不准确
- 冗余代码
- 丑陋代码
- 功能增强
- 性能优化

<a name="DCtqx"></a>
### 5. 贡献最佳实践

SREWorks是一个云原生运维中台,我们期望它能够支持尽可能多的运维场景,如果您有一个基于SREWorks实现的最佳实践,您可以直接发邮件 [dataops@service.alibaba.com](mailto:dataops@service.alibaba.com) 告诉我们或[提交Issue](https://github.com/alibaba/SREWorks/issues/new)**我们会利用SREWorks平台推广您的最佳实践**。<br />最佳实践包含且不局限于下面这些:

- 某个开源软件的运维方案
- 集成某些开源软件的数据化运维实践


<a name="uoC1Y"></a>
### 6. 贡献运维应用

SREWorks中支持用户开发各种运维应用,如果您觉得您开发的运维应用能够在更多的地方被用到,**建议您可以将您的运维应用提交到公共应用市场**。(公共市场功能尚在准备中,您可以先通过邮件 [dataops@service.alibaba.com](mailto:dataops@service.alibaba.com) 提交)

<a name="gxQpU"></a>
### 2,贡献代码
可以提交代码MR请求,在相关同学完成Review后将合入您的代码
###



8 changes: 8 additions & 0 deletions saas/dataops/api/grafana/launch.yaml.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ spec:
server:
root_url: /gateway/dataops-grafana/
serve_from_sub_path: true
auth.proxy:
enabled: true
auto_sign_up: true
enable_login_token: false
ldap_sync_ttl: 60
sync_ttl: 60
header_name: x-auth-user
headers: "Name:x-auth-user Email:x-auth-email-addr"
auth.anonymous:
enabled: true
image:
Expand Down

0 comments on commit d903f18

Please sign in to comment.