From 292c2d459413bd83e34cbdfde2e203c14501ec20 Mon Sep 17 00:00:00 2001 From: Darren <27513732@qq.com> Date: Fri, 21 Jul 2023 16:14:35 +0800 Subject: [PATCH] docs --- CHANGELOG.md | 16 ++++---- CONTRIBUTING.md | 40 ++++++++++++++++++- SECURITY.md | 15 +++++++ appmanage/README.md | 3 +- appmanage/docs/{developer.md => DEV-SETUP.md} | 2 +- appmanage/docs/architecture.md | 2 + docs/administrator.md | 16 -------- docs/architecture.md | 2 +- docs/developer.md | 38 ------------------ docs/{ => notes}/PRD.md | 0 10 files changed, 67 insertions(+), 67 deletions(-) create mode 100644 SECURITY.md rename appmanage/docs/{developer.md => DEV-SETUP.md} (94%) delete mode 100644 docs/administrator.md rename docs/{ => notes}/PRD.md (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bf3f102..3f3e3f62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,22 +1,22 @@ ## 0.7.3 release on 2023-07-06 -appmanage ci 更新 +1. appmanage ci 更新 ## 0.7.2 release on 2023-06-25 -appmanage 自动更新接口升级 +1. appmanage 自动更新接口升级 ## 0.7.1 release on 2023-06-21 -appmanage version 文件意外删除时 bug 修改 -自动更新的时间频率调整为一天 -更新脚本 version 文件不存在的 bug 修改 +1. appmanage version 文件意外删除时 bug 修改 +2. 自动更新的时间频率调整为一天 +3. 更新脚本 version 文件不存在的 bug 修改 ## 0.7.0 release on 2023-06-20 -appstore 增加 更新功能 -myapps 功能优化 -新增 settings(设置) 功能 +1. appstore 增加 更新功能 +2. myapps 功能优化 +3. 新增 settings(设置) 功能 ## 0.6.0 release on 2023-06-17 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7106b2a4..3c83c0b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,41 @@ # Contributing to Websoft9 -This page provides information about contributing code to the Websoft9 core codebase. \ No newline at end of file +From opening a bug report to creating a pull request: every contribution is appreciated and welcome. + +If you're planning to implement a new feature or change the api please [create an issue](https://github.com/websoft9/websoft9/issues/new/choose) first. This way we can ensure that your precious work is not in vain. + + +## Not Sure Architecture? + +It's important to figure out the design [architecture of Websoft9](docs/architecture.md) + +## Fork + +Contributor only allow to fork [main branch](https://github.com/Websoft9/websoft9/tree/main) and pull request for it. Maintainers don't accept any pr to **production branch** + +## Pull request + +## DevOps principle + +We follow the development principle of minimization, rapid release + +### Version + +Use *[[major].[minor].[patch]](https://semver.org/lang/zh-CN/)* for version serial number and [version.json](../version.json) for version dependencies + +### Artifact + +Websoft9 use below [Artifact](https://jfrog.com/devops-tools/article/what-is-a-software-artifact/) for different usage: + +* **Dockerhub for image**: Access [Websoft9 docker images](https://hub.docker.com/u/websoft9dev) on Dockerhub +* **Azure Storage for files**: Access [packages list](https://w9artifact.blob.core.windows.net/release?restype=container&comp=list) at [Azure Storage](https://learn.microsoft.com/en-us/azure/storage/storage-dotnet-how-to-use-blobs#list-the-blobs-in-a-container) + +### Tags + +- Type tags: Bug, enhancement, Documetation +- Stages Tags: PRD, Dev, QA(include deployment), Documentation + +### WorkFlow + +Websoft9 use the [gitlab workflow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) for development collaboration + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..72296ea8 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +## Versions + +As an open source product, we will only patch the latest major version for security vulnerabilities. Previous versions of Websoft9 will not be retroactively patched. + +## Disclosing + +You can get in touch with us regarding a vulnerability via [issue](https://github.com/Websoft9/websoft9/issues) or email at help@websoft9.com. + +You can also disclose via huntr.dev. If you believe you have found a vulnerability, please disclose it on huntr and let us know. + +https://huntr.dev/bounties/disclose + +This will enable us to review the vulnerability and potentially reward you for your work. \ No newline at end of file diff --git a/appmanage/README.md b/appmanage/README.md index 47793165..07d44480 100644 --- a/appmanage/README.md +++ b/appmanage/README.md @@ -4,5 +4,4 @@ AppManage is the core of Websoft9 which can manage application: Create, Stop, Un * [API-design](docs/API-design.md) * [Architecture](docs/architecture.md) -* [Developer](docs/developer.md) - +* [Dev-Setup](docs/DEV-SETUP.md) \ No newline at end of file diff --git a/appmanage/docs/developer.md b/appmanage/docs/DEV-SETUP.md similarity index 94% rename from appmanage/docs/developer.md rename to appmanage/docs/DEV-SETUP.md index 21e87b07..47bc2b66 100644 --- a/appmanage/docs/developer.md +++ b/appmanage/docs/DEV-SETUP.md @@ -1,4 +1,4 @@ -# Developer +# Dev-Setup ## Deployment diff --git a/appmanage/docs/architecture.md b/appmanage/docs/architecture.md index a63233ab..6c21e8c6 100644 --- a/appmanage/docs/architecture.md +++ b/appmanage/docs/architecture.md @@ -51,6 +51,8 @@ cancel_jobs = cancel.get_job_ids() ## Logs partition +Appmanage 日志采用 logging 生成，按自然日分割日志文件。日志路径：/var/lib/docker/volumes/w9appmanage_logs/\_data + ``` logPath = 'logs/' if not os.path.exists(logPath): diff --git a/docs/administrator.md b/docs/administrator.md deleted file mode 100644 index 5133d2fa..00000000 --- a/docs/administrator.md +++ /dev/null @@ -1,16 +0,0 @@ -# Administrator 管理手册 - -## 数据同步 - -1. 将 APP 的版本号、最小 CPU、内存、磁盘空间同步到 Contenful 数据表，通过自动化[Github Action](https://github.com/Websoft9/docker-library/blob/main/.github/workflows/requirement_to_contentful.yml)实现。 - -2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images)，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/logo.yml)实现。 - -## AppManage 镜像生成 - -发布镜像到 Dockhub 的 websoft9dev 组织下，通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/appmanage_docker.yml)实现。 - -## 日志 - -Appmanage 日志采用 logging 生成，按自然日分割日志文件。日志路径：/var/lib/docker/volumes/w9appmanage_logs/\_data -其他微服务采用 Dockhub 公开镜像，用 docker 容器的日志访问命令即可查看。 diff --git a/docs/architecture.md b/docs/architecture.md index 78be3845..936d5eb1 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -14,7 +14,7 @@ What we do is integrating below stacks's API or interfaces to Cockpit console by - [Duplicati](https://www.duplicati.com/): Backup software to store encrypted backups online - [Redis](https://redis.io/): The open source, in-memory data store - [Appmanage](https://github.com/Websoft9/websoft9/tree/main/appmanage): API for create and manage docker compose based application powered by Websoft9 - +- [websoft9-plugin](https://github.com/websoft9?q=plugin&type=all&language=&sort=): Cockpit packages powered by Websoft9 As Websoft9 is a complete product, we also offer: diff --git a/docs/developer.md b/docs/developer.md index 75223ea3..cc73f6bf 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -1,45 +1,11 @@ # Developer Guide -## Version - -Use *[[major].[minor].[patch]](https://semver.org/lang/zh-CN/)* for version serial number and [version.json](../version.json) for version dependencies - -## Artifact - -The core of DevOps is continue publish, the format of software publish is [Artifact（制品库）](https://jfrog.com/devops-tools/article/what-is-a-software-artifact/). - -Websoft9 use below Artifact for different usage: - -#### Dockerhub for image - -Access [Websoft9 docker images](https://hub.docker.com/u/websoft9dev) on Dockerhub - -#### Azure Storage package - -Access [packages list](https://w9artifact.blob.core.windows.net/release?restype=container&comp=list) at Azure Storage ## Release -#### CHANGELOG format -``` -## 0.3.0 release on 2023-06-06 - -1. appmanage docker update to 0.3.0 -2. fix prestashop 502 -``` - -### 制品库管理 - -版本管理部仅仅是对代码的管理，还需要对软件可执行成果物-制品的管理，websoft9 项目会将所有成果作为公开制品。 - -#### 制品库选型 - -Dockerhub, Github packages, Azure artifacts, CODING 制品库 - -> 非容器类制品优先选择 Github packages #### 制品库自动化 @@ -56,7 +22,3 @@ Dockerhub, Github packages, Azure artifacts, CODING 制品库 自动化测试成功，同步 version_test.json 到 version.json， 新制品正式发布。 -### Contributor - -- 类型标签：Bug, enhancement, Documetation -- 过程标签：PRD, Dev, QA(include deployment), Documetation \ No newline at end of file diff --git a/docs/PRD.md b/docs/notes/PRD.md similarity index 100% rename from docs/PRD.md rename to docs/notes/PRD.md