You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2024/05/31 06:25:15 UTC
(skywalking-banyandb) branch main updated: docs: optimized the README and the Standalone page. (#454)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
The following commit(s) were added to refs/heads/main by this push:
new 85ffd417 docs: optimized the README and the Standalone page. (#454)
85ffd417 is described below
commit 85ffd4171f028a8697911c6c3bbc0ec1a76e3141
Author: Chen Ziyan <cl...@gmail.com>
AuthorDate: Fri May 31 14:25:10 2024 +0800
docs: optimized the README and the Standalone page. (#454)
---
CONTRIBUTING.md | 2 +-
docs/README.md | 11 ++++++++++-
docs/crud/index_rule_binding.md | 2 +-
docs/installation/binaries.md | 32 +++++++++++++++++++++++++++++++-
docs/installation/cluster.md | 2 +-
docs/installation/standalone.md | 27 +++++++++++++++++++++------
docs/menu.yml | 2 +-
7 files changed, 66 insertions(+), 12 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5a5ecf29..d2a0c5df 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -44,7 +44,7 @@ Users who want to build a binary from sources have to set up:
* Go 1.22
* Node 20.12
* Git >= 2.30
-* Linux, macOS or Windows+WSL2
+* Linux, macOS or Windows + WSL2
* GNU make
### Windows
diff --git a/docs/README.md b/docs/README.md
index 8185677b..c1030c72 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,7 +2,12 @@
## Welcome to the BanyanDB
-Here you can learn all you need to know about BanyanDB.
+**BanyanDB**, as an observability database, aims to ingest, analyze and store Metrics, Tracing, and Logging data. It's
+designed to handle observability data generated by **Apache SkyWalking**. Before BanyanDB emerges, the Databases that
+SkyWalking adopted are not ideal for the APM data model, especially for saving tracing and logging data. Consequently,
+There’s room to improve the performance and resource usage based on the nature of SkyWalking data patterns.
+
+Here you can learn all you need to know about BanyanDB. Let's get started with it.
- **Installation**. Instruments about how to download and onboard BanyanDB server, Banyand.
- **Clients**. Some native clients to access Banyand.
@@ -10,6 +15,8 @@ Here you can learn all you need to know about BanyanDB.
- **Concept**. Learn the concepts of Banyand. Includes the architecture, data model, and so on.
- **CRUD Operations**. To create, read, update, and delete data points or entities on resources in the schema.
+### Useful Links
+
You might also find these links interesting:
- The latest and old releases are all available
@@ -22,6 +29,8 @@ You might also find these links interesting:
- You can find the conference schedules, video recordings, and articles about SkyWalking in
the [community resource catalog](https://github.com/OpenSkywalking/Community).
+### Contact Us
+
We're always looking for help to improve our documentation and codes, so please don’t hesitate
to [file an issue](https://github.com/apache/skywalking/issues/new) if you see any problems. Or better yet, directly
contribute by submitting a pull request to help us get better!
diff --git a/docs/crud/index_rule_binding.md b/docs/crud/index_rule_binding.md
index 078ad29f..0e8158d1 100644
--- a/docs/crud/index_rule_binding.md
+++ b/docs/crud/index_rule_binding.md
@@ -1,4 +1,4 @@
-# CRUD indexRuleBindings
+# CRUD IndexRuleBindings
CRUD operations create, read, update and delete index rule bindings.
diff --git a/docs/installation/binaries.md b/docs/installation/binaries.md
index 284316fc..c6659374 100644
--- a/docs/installation/binaries.md
+++ b/docs/installation/binaries.md
@@ -3,8 +3,38 @@
This page shows how to get binaries of Banyand.
## Prebuilt Released binaries
+
+Go to the [SkyWalking download page](https://skywalking.apache.org/downloads/#Database) .
-Get binaries from the [download](https://skywalking.apache.org/downloads/).
+Select and download the distribution from the suggested location for your platform, such as `skywalking-banyandb-x.x.x-bin.tgz`.
+
+> It is essential that you verify the integrity of the downloaded file using the PGP signature ( .asc file) or a hash ( .md5 or .sha* file).
+
+unpack and extract the package.
+
+```shell
+$ tar -zxvf skywalking-banyandb-x.y.z-bin.tgz
+```
+
+The directory structure is as follows.
+
+```shell
+├── CHANGES.md
+├── LICENSE
+├── LICENSE.tpl
+├── NOTICE
+├── README.md
+├── bin
+│ ├── banyand-server-static
+│ ├── bydbctl-x.y.z-darwin-amd64
+│ ├── bydbctl-x.y.z-darwin-arm64
+│ ├── bydbctl-x.y.z-linux-386
+│ ├── bydbctl-x.y.z-linux-amd64
+│ ├── bydbctl-x.y.z-linux-arm64
+│ ├── bydbctl-x.y.z-windows-386
+│ └── bydbctl-x.y.z-windows-amd64
+└── licenses
+```
## Build From Source
diff --git a/docs/installation/cluster.md b/docs/installation/cluster.md
index 0db4d8b2..4fbb8055 100644
--- a/docs/installation/cluster.md
+++ b/docs/installation/cluster.md
@@ -1,4 +1,4 @@
-# Cluster Installation
+# Installing BanyanDB Cluster Mode
## Setup Meta Nodes
diff --git a/docs/installation/standalone.md b/docs/installation/standalone.md
index 6293c24e..52768fce 100644
--- a/docs/installation/standalone.md
+++ b/docs/installation/standalone.md
@@ -1,22 +1,37 @@
-# Standalone Mode
+# Installing BanyanDB Standalone Mode
-The standalone mode is the simplest way to run Banyand. It is suitable for the development and testing environment. Once you unpack and extract the `skywalking-banyandb-x.x.x-bin.tgz`, you could startup BanyanDB server, the standalone mode is running as a standalone process.
+The standalone mode is the simplest way to run Banyand. It is suitable for the development and testing environment.
+
+Follow these steps to install BanyanDB and start up in standalone mode.
+
+
+- Download or build the BanyanDB packages.
+- unpack and extract the `skywalking-banyandb-x.x.x-bin.tgz`.
+- start up BanyanDB standalone server.
```shell
-$ cd skywalking-banyandb-x.x.x-bin/bin
-$ ./banyand-server-static standalone
+$ ./bin/banyand-server-static standalone
+```
+
+Then the server running as a standalone process.
+
+```shell
+
██████╗ █████╗ ███╗ ██╗██╗ ██╗ █████╗ ███╗ ██╗██████╗ ██████╗
██╔══██╗██╔══██╗████╗ ██║╚██╗ ██╔╝██╔══██╗████╗ ██║██╔══██╗██╔══██╗
██████╔╝███████║██╔██╗ ██║ ╚████╔╝ ███████║██╔██╗ ██║██║ ██║██████╔╝
██╔══██╗██╔══██║██║╚██╗██║ ╚██╔╝ ██╔══██║██║╚██╗██║██║ ██║██╔══██╗
██████╔╝██║ ██║██║ ╚████║ ██║ ██║ ██║██║ ╚████║██████╔╝██████╔╝
╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═══╝╚═════╝ ╚═════╝
-***starting as a standalone server****
+{"level":"info","time":"2024-05-28T11:27:58+08:00","message":"starting as a standalone server"}
...
...
-***Listening to**** addr::17912 module:LIAISON-GRPC
+{"level":"info","module":"LIAISON-GRPC","addr":":17912","time":"2024-05-28T11:27:59+08:00","message":"Listening to"}
+{"level":"info","module":"LIAISON-HTTP","listenAddr":":17913","time":"2024-05-28T11:27:59+08:00","message":"Start liaison http server"}
```
The banyand server would be listening on the `0.0.0.0:17912` to access gRPC requests. if no errors occurred.
At the same time, the banyand server would be listening on the `0.0.0.0:17913` to access HTTP requests. if no errors occurred. The HTTP server is used for CLI and Web UI.
+
+The Web UI is hosted at `http://localhost:17913/`.
diff --git a/docs/menu.yml b/docs/menu.yml
index c178978b..8e081587 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -26,7 +26,7 @@ catalog:
path: "/installation/standalone"
- name: "Cluster Mode"
path: "/installation/cluster"
- - name: "Concept"
+ - name: "Concepts"
catalog:
- name: "Data Model"
path: "/concept/data-model"