mirror of
https://github.com/iflytek/skillhub.git
synced 2026-09-23 00:41:41 +00:00
docs: remove legacy documentation references
Signed-off-by: XiaoSeS <87064762+XiaoSeS@users.noreply.github.com>
This commit is contained in:
parent
180c85a060
commit
6f565e0a3c
3 changed files with 3 additions and 9 deletions
|
|
@ -15,7 +15,7 @@ backend**, a **React web UI**, a **security scanner**, and a **ClawHub CLI compa
|
|||
| Cache | Redis 7 (sessions, distributed locks, idempotency) |
|
||||
| Storage | LocalFile (dev) / S3/MinIO (prod) |
|
||||
| Build | `make dev-all` (dev), `make staging` (pre-PR) |
|
||||
| Docs | `docs/` (design), `document/` (VitePress user guide) |
|
||||
| Docs | `docs/` (design), `docs/skillhub/` (VitePress user guide) |
|
||||
| CI | GitHub Actions (`.github/workflows/`) |
|
||||
|
||||
## Directory Map
|
||||
|
|
@ -149,11 +149,6 @@ skillhub/
|
|||
│ ├── skillhub/ # VitePress user guide source
|
||||
│ └── superpowers/ # Internal tooling docs
|
||||
│
|
||||
├── document/ # VitePress documentation site (published)
|
||||
│ ├── docs/ # Markdown documentation
|
||||
│ ├── src/ # VitePress theme
|
||||
│ └── i18n/ # Internationalization
|
||||
│
|
||||
├── deploy/k8s/ # Kubernetes manifests (basic)
|
||||
├── monitoring/ # Prometheus + Grafana stack
|
||||
├── scripts/ # Build, test, and deployment scripts
|
||||
|
|
@ -210,7 +205,6 @@ skillhub/
|
|||
### Do Not Manually Edit Generated Files
|
||||
|
||||
- `web/src/api/generated/schema.d.ts` — regenerated via `make generate-api`
|
||||
- `document/docs/` — auto-generated user documentation (VitePress)
|
||||
- `server/skillhub-app/src/main/java/com/iflytek/skillhub/dto/` — some DTOs may be generated
|
||||
|
||||
### After Making Changes
|
||||
|
|
|
|||
|
|
@ -308,7 +308,7 @@ A: SkillHub's default Compose and `runtime.sh` use a Docker named volume (`postg
|
|||
Check the following in order:
|
||||
|
||||
1. Prefer switching back to a Docker named volume, or use the official `runtime.sh` to avoid missing permission settings in a hand-written Compose file.
|
||||
2. If a bind mount is required, run `docker run --rm postgres:16-alpine id postgres` to identify the actual UID/GID of the `postgres` user in the selected image. Then change the data-directory owner accordingly, for example `chown -R <uid>:<gid> <data-dir>`. Do not assume every environment uses `999:999`.
|
||||
2. If a bind mount is required, first identify the effective `POSTGRES_IMAGE` selected by `.env.release` or the `runtime.sh` options. Export that value in the current shell, then run `docker run --rm "$POSTGRES_IMAGE" id postgres`. Change the data-directory owner to the reported UID/GID, for example `chown -R <uid>:<gid> <data-dir>`. Do not assume the image is `postgres:16-alpine`, or that every environment uses `999:999`.
|
||||
3. Check SELinux on RHEL/CentOS. With AppArmor, rootless Docker, NFS, CIFS, or NAS storage, also verify that the host filesystem permits PostgreSQL to write, lock files, and change permissions.
|
||||
4. Avoid placing PostgreSQL `PGDATA` on network filesystems without full POSIX permission semantics. For production, prefer local disks, Docker named volumes, block storage, or an external PostgreSQL service.
|
||||
|
||||
|
|
|
|||
|
|
@ -308,7 +308,7 @@ A: SkillHub 默认的 Compose 和 `runtime.sh` 使用 Docker named volume(`pos
|
|||
按以下顺序排查:
|
||||
|
||||
1. 优先恢复为 Docker named volume,或使用官方 `runtime.sh`,避免手写 Compose 时漏配权限。
|
||||
2. 如果必须使用 bind mount,先运行 `docker run --rm postgres:16-alpine id postgres`,确认当前镜像中 `postgres` 用户的 UID/GID,再按实际值调整数据目录属主,例如 `chown -R <uid>:<gid> <数据目录>`。不要固定假设所有环境都是 `999:999`。
|
||||
2. 如果必须使用 bind mount,先确认 `.env.release` 或 `runtime.sh` 参数最终选择的 `POSTGRES_IMAGE`,将该值导出到当前 shell 后运行 `docker run --rm "$POSTGRES_IMAGE" id postgres`。再按输出的实际 UID/GID 调整数据目录属主,例如 `chown -R <uid>:<gid> <数据目录>`。不要固定假设镜像是 `postgres:16-alpine`,也不要假设所有环境都是 `999:999`。
|
||||
3. 在 RHEL/CentOS 上检查 SELinux;使用 AppArmor、rootless Docker、NFS、CIFS 或 NAS 时,也要确认宿主文件系统允许 PostgreSQL 写入、加锁和更改权限。
|
||||
4. 不建议把 PostgreSQL `PGDATA` 放在缺少完整 POSIX 权限语义的网络文件系统上。生产环境优先使用本地盘、Docker named volume、块存储或外部 PostgreSQL。
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue