Skip to content

Commit

Permalink
refine docs homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
laiwei committed Nov 17, 2023
1 parent 49b1cf5 commit 3346415
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 24 deletions.
2 changes: 1 addition & 1 deletion assets/scss/common/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ $border-color: $gray-200;
// Font, line-height, and color for body text, headings, and more.

// stylelint-disable value-keyword-case
$font-family-sans-serif: "Jost", -apple-system, blinkmacsystemfont, "Segoe UI", roboto, "Helvetica Neue", arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
$font-family-sans-serif: "Helvetica Neue", "sans-serif", "PingFangSC-Regular", "Microsoft Yahei", "Jost", -apple-system, blinkmacsystemfont, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
$font-family-monospace: sfmono-regular, menlo, monaco, consolas, "Liberation Mono", "Courier New", monospace;
$font-family-base: $font-family-sans-serif;
// stylelint-enable value-keyword-case
Expand Down
4 changes: 2 additions & 2 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ lqipWidth = "20x"
smallLimit = "300"

# Footer
footer = "© 2022 CCF·Nightingale, all rights reserved."
footer = "© 2023 CCF·Nightingale, all rights reserved."

# Feed
copyRight = "© 2022 CCF·Nightingale, all rights reserved."
copyRight = "© 2023 CCF·Nightingale, all rights reserved."

# Alert
alert = false
Expand Down
2 changes: 1 addition & 1 deletion content/en/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title : "Nightingale"
description: "An enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and Grafana for visualization."
lead: "An enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and Grafana for visualization."
lead: "An all-in-one observability solution which aims to combine the advantages of Prometheus and Grafana. It manages alert rules and visualizes metrics, logs, traces in a beautiful web UI."
date: 2020-10-06T08:47:36+00:00
lastmod: 2020-10-06T08:47:36+00:00
draft: false
Expand Down
11 changes: 5 additions & 6 deletions content/en/docs/install/binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,30 @@ toc: true

## Download

Download the latest release from [Github](https://github.com/ccfos/nightingale/releases)
Download the latest release from [GitHub](https://github.com/ccfos/nightingale/releases), then you will get a tarball which name is like `n9e-{version}-linux-amd64.tar.gz`

## Install

```bash
#!/bin/bash
mkdir /opt/n9e && tar zxvf n9e-v6.0.1-linux-amd64.tar.gz -C /opt/n9e
mkdir /opt/n9e && tar zxvf n9e-{version}-linux-amd64.tar.gz -C /opt/n9e

cd /opt/n9e

# init database
mysql -uroot -p1234 < n9e.sql

# check configurations in /opt/n9e/etc/config.toml
# check configurations in /opt/n9e/etc/config.toml and start n9e
nohup ./n9e &> n9e.log &
```

## Check Process

```bash
# check process is runing or not
ss -tlnp|grep 17000
```

## Login

[http://localhost:17000](http://localhost:17000)。Default username is root and default password is `root.2020`.


Open web browser and go to [http://localhost:17000](http://localhost:17000). The default username is `root` and default password is `root.2020`.
4 changes: 2 additions & 2 deletions content/en/docs/install/compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ toc: true


```bash
$ git clone https://gitlink.org.cn/ccfos/nightingale.git
$ git clone https://github.com/ccfos/nightingale.git
$ cd nightingale/docker/compose-bridge

$ docker-compose up -d
Expand All @@ -39,7 +39,7 @@ prometheus prom/prometheus "/bin/prometheus --c…"
redis redis:6.2 "docker-entrypoint.s…" redis 2 days ago Up 2 days
```

Use your browser to access Nightingale's web page at [http://localhost:17000](http://localhost:17000). The default username is root and default password is `root.2020`.
Use your browser to access Nightingale's web page at [http://localhost:17000](http://localhost:17000). The default username is `root` and default password is `root.2020`.



4 changes: 2 additions & 2 deletions content/en/docs/install/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ weight: 620
toc: true
---

[https://github.com/flashcatcloud/n9e-helm](https://github.com/flashcatcloud/n9e-helm)
You can use the [n9e helm chart](https://github.com/flashcatcloud/n9e-helm) to run n9e in K8s cluster.

The default username is root and default password is `root.2020`.
The default n9e username is `root` and password is `root.2020`.
4 changes: 2 additions & 2 deletions content/en/docs/prologue/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ weight: 100
toc: true
---

Nightingale project is an enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and Grafana for visualization.
Nightingale project is an all-in-one observability solution which aims to combine the advantages of Prometheus and Grafana. It manages alert rules and visualizes metrics, logs, traces in a beautiful web UI.

## Repo

Expand All @@ -27,7 +27,7 @@ Any issues or PRs are welcome!
<br />
<br />

The Nightingale project is very open and can interface with common collectors in the open source community, such as categraf, telegraf, datadog-agent, grafana-agent, as well as common time series databases in the open source community, such as Prometheus, VictoriaMetrics, Thanos, as well as logging stores, such as ElasticSearch, Loki, as well as common notification mediums, such as Slack, mm, Dingtalk, Wecom.
The Nightingale project is very open and can interact with common collectors in the open source community, such as categraf, telegraf, datadog-agent, grafana-agent, as well as common time series databases in the open source community, such as Prometheus, VictoriaMetrics, Thanos, as well as logging stores, such as ElasticSearch, Loki, as well as common notification mediums, such as Slack, mm, Dingtalk, Wecom.

## Key Capabilities

Expand Down
4 changes: 2 additions & 2 deletions content/zh/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title : "Nightingale | 夜莺监控"
description: "An enterprise-level cloud-native monitoring system, which can be used as drop-in replacement of Prometheus for alerting and Grafana for visualization."
description: "开源监控 | 云原生监控 | 统一监控 | 开源可观测性工具"
lead: "升级您的 Prometheus + AlertManager + Grafana 到 Nightingale"
date: 2020-10-06T08:47:36+00:00
lastmod: 2020-10-06T08:47:36+00:00
draft: false
images: []
buttonText: "开始使用"
metaText: "Nightingale | 夜莺监控,一款先进的开源云原生监控分析系统,采用 All-In-One 的设计,集数据采集、可视化、监控告警、数据分析于一体,与云原生生态紧密集成,提供开箱即用的企业级监控分析和告警能力。于 2022 年 5 月 11 日,捐赠予中国计算机学会开源发展委员会(CCF ODC),为 CCF ODC 成立后接受捐赠的首个开源项目"
metaText: "Nightingale | 夜莺监控是一个 All-in-One 的云原生监控工具,集合了 Prometheus 和 Grafana 的优点,你可以在 UI 上管理和配置告警策略,也可以对分布在多个 Region 的指标、日志、链路追踪数据进行统一的可视化和分析。夜莺融入了顶级互联网公司可观测性最佳实践,沉淀了众多社区专家经验,开箱即用。夜莺监控项目,托管于中国计算机学会开源发展委员会(CCF ODC,为 CCF ODC 成立后接受捐赠的第一个开源项目"
startLink: "https://flashcat.cloud/docs/"
---

28 changes: 22 additions & 6 deletions layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,44 @@ <h1 class="mt-0">{{ .Title }}</h1>
{{ if eq $.Site.Language.LanguageName "Chinese" }}
<section class="section section-sm">
<div class="container">
<div class="row justify-content-center text-center">
<div class="row justify-content-center text-center">
<div class="col-lg-5">
<h2 class="h4">开箱即用</h2>
<p>支持 Docker、Helm Chart、云服务等多种部署方式;集数据采集、监控告警、可视化为一体;内置多种监控仪表盘、快捷视图、告警规则模板,导入即可快速使用;大幅降低云原生监控系统的建设成本、学习成本、使用成本</p>
<p>
支持 Docker、Helm Chart、Binary等多种部署方式;
支持 Categraf、Telegraf、Grafana-agent、Datadog-agent 等常见的采集器;
内置常见中间件和云服务的仪表盘模版、告警规则模版,导入即可快速使用;
一个工具解决数据采集、可视化、告警、通知等问题;
</p>
</div>
<div class="col-lg-5">
<h2 class="h4">专业告警</h2>
<p>可视化的告警配置和管理,支持丰富的告警规则,提供屏蔽规则、订阅规则的配置能力,支持告警多种送达渠道,支持告警自愈、告警事件管理等</p>
<p>
可视化的管理和配置告警,告警规则功能丰富,支持组合告警策略、多生效周期、告警屏蔽、告警订阅、告警回调,支持告警多种送达渠道,支持告警自愈、告警事件管理等。可以在一个平台上配置和管理多个Region的告警。
</p>
</div>
<div class="col-lg-5">
<h2 class="h4">云原生</h2>
<p>以交钥匙的方式快速构建企业级的云原生监控体系,支持 Categraf、Telegraf、Grafana-agent 等多种采集器,支持 Prometheus、VictoriaMetrics、M3DB、ElasticSearch 等多种数据库,兼容支持导入 Grafana 仪表盘,与云原生生态无缝集成</p>
<p>
支持 K8s 数据采集和监控;
支持 OpenTelemetry 协议和采集器;
兼容 Grafana 仪表盘;
可接入 Prometheus、VictoriaMetrics、M3DB、ElasticSearch、ClickHouse 等多种数据源;
</p>
</div>
</div>
<div class="row justify-content-center text-center">
<div class="col-lg-5">
<h2 class="h4">高性能、高可用</h2>
<p>得益于夜莺的多数据源管理引擎,和夜莺引擎侧优秀的架构设计,借助于高性能时序库,可以满足数亿时间线的采集、存储、告警分析场景,节省大量成本;夜莺监控组件均可水平扩展,无单点,已在上千家企业部署落地,经受了严苛的生产实践检验</p>
<p>
多数据源管理引擎、高性能时序库、水平扩展的架构、无单点的设计,决定了夜莺的高性能和高可用。夜莺可以满足数亿时间线的采集、存储、告警分析场景,节省大量成本,已在上千家企业部署落地,经受了严苛的生产实践检验。
</p>
</div>
<div class="col-lg-5">
<h2 class="h4">灵活扩展、中心化管理</h2>
<p>夜莺监控,可部署在 1 核 1G 的云主机,可在上百台机器集群化部署,可运行在 K8s 中;也可将时序库、告警引擎等组件下沉到各机房、各 Region,兼顾边缘部署和中心化统一管理,解决数据割裂,缺乏统一视图的难题</p>
<p>
夜莺监控,可部署在 1 核 1G 的云主机,可在上百台机器集群化部署,可运行在 K8s 中;也可将时序库、告警引擎等组件下沉到各Region,统一管理多个边缘节点,解决多Region监控数据割裂,缺乏统一视图的难题。
</p>
</div>
<div class="col-lg-5">
<h2 class="h4">开放社区</h2>
Expand Down

0 comments on commit 3346415

Please sign in to comment.