Add comprehensive documentation for CLICD features and operations

- Introduced Container Management documentation covering lifecycle operations, resource management, and console access.
- Added Dashboard documentation detailing metrics and related APIs.
- Created Host Report documentation summarizing host environment and resource status.
- Included Image Management documentation for template handling and management actions.
- Documented Networking and Routing features including NAT4 and IPv6 management.
- Added Security Alerts documentation outlining alert scenarios and API usage.
- Created Snapshot Management documentation for snapshot operations and scheduling.
- Documented Sub-user management for granting access to specific containers.
- Added Configuration guide detailing runtime settings and security recommendations.
- Created Installation guide for setting up CLICD with requirements and steps.
- Added Introduction and Quick Start guides for new users.
- Documented Upgrade process with version checking and pre-upgrade checklist.
- Created Deployment guide for service exposure and firewall recommendations.
- Added FAQ section addressing common questions and concerns.
- Documented Troubleshooting steps for common issues encountered.
This commit is contained in:
MengMengCode
2026-06-10 00:42:06 +08:00
parent e71adf6830
commit a45e063fc2
29 changed files with 2332 additions and 122 deletions
+42
View File
@@ -0,0 +1,42 @@
# Local Build
## Frontend Build
```bash
cd frontend
npm install
npm run build
```
Build output is written to `frontend/dist`.
## Backend Build
```bash
cd backend
go test ./...
go build -o ../build/clicd .
```
To package the embedded web panel, sync the frontend build output into the backend embed directory first.
## One-command Build
The project root provides a build script:
```bash
bash build.sh
```
The script chains frontend build, static asset sync, and Go binary build.
## Docs Build
```bash
cd docs
npm install
npm run dev
npm run build
```
`npm run dev` starts a local preview, and `npm run build` generates static documentation.