Add OPC UA and the other missing engines to the README connection captions

Open Beginner friendly
  • Is something wrong?
#2,162 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Start with the caption lines in README.md (around 164 and 177), README_zh.md (176 and 190) and README_ko.md (193 and 211), and compare them with the engine ids in EXTERNAL_DATABASE_TYPES in src/lib/db/compatibility.ts. The three captions are pinned by assertions at lines 2038-2059 of tests/unit/db/s3/provider-doc.test.ts, which you must update with the new text. Done when the grep checks in the issue show the new wording and bun tests/run-tests.ts tests/unit/db/s3/provider-doc.test.ts passes.

Written by the indexing model from the issue text.

Description

documentation good first issue

What

The caption under the connection screenshot names the engines you can connect to. In README.md it misses OPC UA, NETCONF, SNMP and Sparkplug B, and its parenthetical has a garbled clause, "NETCONF Sparkplug B is reached over SSH". The Chinese caption misses OPC UA and SNMP, and the Korean one misses OPC UA. Separately, the "not SQL" sentence in the Chinese and Korean READMEs starts at Oxia, where the English one starts with OPC UA, Kubernetes and S3-compatible object storage.

Where

  • README.md:177, the list ends:

    InfluxDB 3 (SQL), Oxia, S3-compatible object storage, Kubernetes, MTConnect and Modbus with SSL/TLS and SSH Tunnel support

    and the parenthetical reads:

    NETCONF Sparkplug B is reached over SSH with the device's own host key pinned rather than through either

  • README_zh.md:190, the list ends:

    Kubernetes、MTConnect、Modbus、NETCONF、Sparkplug B，支持 SSL/TLS 与 SSH 隧道

  • README_ko.md:211, the list ends:

    Kubernetes, MTConnect, Modbus, NETCONF, SNMP, Sparkplug B에 연결할 수 있으며

  • README.md:164

    None of OPC UA, Kubernetes, S3-compatible object storage, Oxia, InfluxDB (InfluxQL), Milvus, Qdrant, Weaviate, Neo4j, etcd, Apache Kafka, MQTT, RabbitMQ and Prometheus is SQL at all

  • README_zh.md:176

    Oxia、InfluxDB (InfluxQL)、Milvus、Qdrant、Weaviate、Neo4j、etcd、Apache Kafka、MQTT、RabbitMQ 和 Prometheus 都和 MongoDB、Redis 一样完全不是 SQL

  • README_ko.md:193

    Oxia, InfluxDB (InfluxQL), Milvus, Qdrant, Weaviate, Neo4j, etcd, Apache Kafka, MQTT, RabbitMQ, Prometheus는 MongoDB나 Redis와 마찬가지로 SQL을 사용하지 않습니다.

The source of truth for the engine set is EXTERNAL_DATABASE_TYPES in src/lib/db/compatibility.ts, which holds 42 engines, including opcua, netconf, snmp and sparkplug.

Expected

  • Each caption names all 42 external engines, OPC UA included.
  • The English parenthetical says NETCONF (only) is reached over SSH with the device's host key pinned, as the Chinese caption already does.
  • The Chinese and Korean "not SQL" sentences start with OPC UA, Kubernetes and S3-compatible object storage, like the English one.

How to fix

  1. In README.md:177, add OPC UA, NETCONF, SNMP and Sparkplug B to the engine list, and change "NETCONF Sparkplug B is reached over SSH" to "NETCONF is reached over SSH".
  2. In README_zh.md:190, add OPC UA and SNMP to the list.
  3. In README_ko.md:211, add OPC UA to the list.
  4. In README_zh.md:176 and README_ko.md:193, add OPC UA, Kubernetes and S3-compatible object storage at the start of the list, in that order.
  5. Compare each caption with the labels for the ids in EXTERNAL_DATABASE_TYPES and make sure none is missing.
  6. tests/unit/db/s3/provider-doc.test.ts pins the three captions as they are today, at lines 2038-2040 (README.md), 2048-2050 (README_zh.md) and 2057-2059 (README_ko.md). Update those three assertions to the new caption text, or the test fails.

How to check

grep -c 'Kubernetes, OPC UA, MTConnect' README.md
grep -n 'NETCONF Sparkplug B is reached' README.md
grep -n 'OPC UA、Kubernetes\|OPC UA, Kubernetes' README_zh.md README_ko.md
bun tests/run-tests.ts tests/unit/db/s3/provider-doc.test.ts
bun run readme:check

The first grep should print a higher count than before the fix (the caption gains Kubernetes, OPC UA, MTConnect; keep that order). The second should print nothing. The third should print the two "not SQL" sentences. readme:check does not read the captions; the provider-doc test does.

Backlog

This is entry DOC30 in docs/BACKLOG.md. The PR that fixes it deletes that entry.

Dominant language
TypeScript
Stars
810
Forks
158
Avg merge
9h 48m
Merged PRs (30d)
627

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from libredb/libredb-studio

All issues in libredb/libredb-studio

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.