Copilot commented on code in PR #220:
URL:
https://github.com/apache/skywalking-showcase/pull/220#discussion_r2619289421
##########
docs/readme.md:
##########
@@ -90,9 +94,10 @@ Currently, the features supported are:
| `java-agent-injector` | Use the java agent injector to inject the
Skywalking Java agent and deploy microservices with other SkyWalking agent
enabled. | The
microservices include agents for Java, NodeJS server, browser, Python.
|
| `agent` | Deploy microservices with SkyWalking agent
pre-installed.
| In Kubernetes
scenarios, please use `java-agent-injector` instead of this, if possible.
|
| `cluster` | Deploy SkyWalking OAP in cluster mode, with 2
nodes, and SkyWalking UI.
| Only one of
`cluster` or `single-node` can be enabled.
|
-| `single-node` | Deploy only one single node of SkyWalking OAP, and
SkyWalking UI, ElasticSearch as storage.
| Only one of `cluster` or
`single-node` can be enabled.
|
-| `elasticsearch` | Deploy ElasticSearch as storage, you may want to
disable this if you want to use your own ElasticSearch deployments.
|
|
-| `postgresql` | Deploy PostgreSQL as storage, you may want to
disable this if you want to use your own PostgreSQL deployments.
|
|
+| `single-node` | Deploy only one single node of SkyWalking OAP, and
SkyWalking UI.
| Only one of `cluster` or
`single-node` can be enabled.
|
+| `banyandb` | Deploy BanyanDB as storage, you may want to
disable this if you want to use your own BanyanDB deployments.
| This is the
default storage for the showcase.
|
+| `elasticsearch` | Deploy ElasticSearch as storage, you may want to
disable this if you want to use your own ElasticSearch deployments.
| Alternative storage
option. BanyanDB is used by default.
|
Review Comment:
Inconsistent capitalization of "ElasticSearch" throughout the documentation.
The official product name is "Elasticsearch" (with lowercase 's'). This should
be corrected for consistency and accuracy.
```suggestion
| `elasticsearch` | Deploy Elasticsearch as storage, you may want to
disable this if you want to use your own Elasticsearch deployments.
| Alternative storage
option. BanyanDB is used by default.
|
```
##########
docs/readme.md:
##########
@@ -90,9 +94,10 @@ Currently, the features supported are:
| `java-agent-injector` | Use the java agent injector to inject the
Skywalking Java agent and deploy microservices with other SkyWalking agent
enabled. | The
microservices include agents for Java, NodeJS server, browser, Python.
|
| `agent` | Deploy microservices with SkyWalking agent
pre-installed.
| In Kubernetes
scenarios, please use `java-agent-injector` instead of this, if possible.
|
| `cluster` | Deploy SkyWalking OAP in cluster mode, with 2
nodes, and SkyWalking UI.
| Only one of
`cluster` or `single-node` can be enabled.
|
-| `single-node` | Deploy only one single node of SkyWalking OAP, and
SkyWalking UI, ElasticSearch as storage.
| Only one of `cluster` or
`single-node` can be enabled.
|
-| `elasticsearch` | Deploy ElasticSearch as storage, you may want to
disable this if you want to use your own ElasticSearch deployments.
|
|
-| `postgresql` | Deploy PostgreSQL as storage, you may want to
disable this if you want to use your own PostgreSQL deployments.
|
|
+| `single-node` | Deploy only one single node of SkyWalking OAP, and
SkyWalking UI.
| Only one of `cluster` or
`single-node` can be enabled.
|
Review Comment:
The description for `single-node` should remain consistent with its actual
behavior. If single-node deploys with BanyanDB by default (as indicated by line
98 showing BanyanDB as the default storage), this description should clarify
the storage behavior. Consider revising to something like "Deploy only one
single node of SkyWalking OAP, and SkyWalking UI with default storage." to
maintain clarity about what storage is used, or explicitly mention that storage
can be configured via separate feature flags.
```suggestion
| `single-node` | Deploy only one single node of SkyWalking OAP,
and SkyWalking UI with default storage.
| Only one of `cluster`
or `single-node` can be enabled.
|
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
