schiwagoa/tianji
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update intro document

Browse Source
This commit is contained in:
moonrailgun 2024-02-19 15:34:48 +08:00
parent 5d99bffa87
commit 2afb5e55f7
3 changed files with 2642 additions and 334 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2966
pnpm-lock.yaml
View File

File diff suppressed because it is too large Load Diff

2
src/client/package.json
View File

@ -55,7 +55,7 @@
"zustand": "^4.4.1"
},
"devDependencies": {
"@i18next-toolkit/cli": "1.0.1",
"@i18next-toolkit/cli": "^1.0.2",
"@types/leaflet": "^1.9.8",
"@types/loadable__component": "^5.13.8",
"@types/lodash-es": "^4.17.12",

8
website/docs/intro.md
View File

@ -16,6 +16,14 @@ Tianji(天机, pronunciation Tiān Jī) in chinese which means **Heavenly Opport
The characters 天 (Tiān) and 机 (Jī) can be translated as "heaven" and "machine" or "mechanism" respectively. When combined, it might refer to a strategic or opportunistic plan or opportunity that seems to be orchestrated by a higher power or a celestial force.
## Motivation
During our observations of the website. We often need to use multiple applications together. For example, we need analysis tools such as `GA`/`umami` to check pv/uv and the number of visits to each page, we need an uptime monitor to check the network quality and connectivity of the server, and we need to use prometheus to obtain the status reported by the server to check the quality of the server. In addition, if we develop an application that allows open source deployment, we often need a telemetry system to help us collect the simplest information about other people's deployment situations.
I think these tools should serve the same purpose, so is there an application that can integrate these common needs in a lightweight way? After all, most of the time we don't need very professional and in-depth functions. But in order to achieve comprehensive monitoring, I need to install so many services.
It's good to specialize in one thing, if we are experts in related abilities we need such specialized tools. But for most users who only have lightweight needs, an **All-in-One** application will be more convenient and easier to use.
## Installation
Install Tianji with Docker is very simple. just make sure you have been install docker and docker-compose plugin