Update the SSL/TLS panel sentence in the Japanese, Hindi, Urdu and Portuguese READMEs

Closed Beginner friendly
  • Is something wrong?
#2,160 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
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
clickhouse, markdown, mongodb, redis, typescript
Domain
documentation, internationalization

Research direction

Start with the English paragraph at README.md:383 and the Spanish one at README_es.md:190, which is already correct. Rewrite the SSL/TLS paragraph in README_ja.md:189, README_hi.md:191, README_ur.md:207 and README_pt.md:190 to match, keeping the span dir="rtl" wrapper in the Urdu file. Done when the grep and sed checks in the issue pass and bun run readme:check still succeeds.

Written by the indexing model from the issue text.

Description

documentation good first issue

What

The transport security paragraph in four translated READMEs still says the SSL/TLS panel works on a fixed list of engines and that Oracle, MongoDB and Redis ignore it. README.md now says the panel is honoured by every engine that shows it (all but SQLite, DuckDB and the embedded LibreDB). Oracle, MongoDB and Redis all read the panel's settings. The four paragraphs also leave libSQL out of the engines that accept a connection string, and they lack the Oracle certificate caveat and the Db2 LUW TLS sentence.

Where

  • README_ja.md:189

    SSL/TLSパネルが実際に効くのはPostgreSQL、MySQL、SQL Server、Couchbase、ClickHouse、Druid、Elasticsearch、OpenSearch、Trino、Prometheus、Apache Kafkaです。

  • README_hi.md:191

    SSL/TLS panel अभी PostgreSQL, MySQL, SQL Server, Couchbase, ClickHouse, Druid, Elasticsearch, OpenSearch, Trino, Prometheus और Apache Kafka पर काम करता है।

  • README_ur.md:207

    Oracle، MongoDB اور Redis اس option کو نظر انداز کرتے ہیں

  • README_pt.md:190

    O painel SSL/TLS hoje tem efeito em PostgreSQL, MySQL, SQL Server, Couchbase, ClickHouse, Druid, Elasticsearch, OpenSearch, Trino, Prometheus e Apache Kafka;

The connection-string list in the same paragraphs, for example README_pt.md:190:

Conexões preenchidas com connection string (MongoDB, Couchbase e ClickHouse permitem)

The three engines said to ignore the panel do read it:

  • src/lib/db/providers/sql/oracle/index.ts:1851

    const scheme = this.config.ssl && this.config.ssl.mode !== "disable" ? "tcps://" : "";

  • src/lib/db/providers/document/mongodb/index.ts:1070

    const ssl = this.config.ssl;

  • src/lib/db/providers/keyvalue/redis.ts:1434

    const ssl = this.config.ssl;

libSQL offers the connection-string field: src/lib/db/connection-fields.ts:459

libsql: ["host", "port", "user", "password", "connectionString"],

Expected

Each of the four paragraphs says what README.md:383 says:

  • the connection-string option exists for MongoDB, Couchbase, ClickHouse and libSQL;
  • the SSL/TLS panel is honoured by every engine that shows it, which is every engine except SQLite, DuckDB and the embedded LibreDB;
  • on Trino it is required, because the coordinator refuses a password over plain HTTP;
  • Oracle's Thin driver always verifies the certificate chain, so require needs the server's CA for a self-signed certificate, and a pasted connect string keeps its own protocol;
  • Db2 LUW refuses a connection without TLS unless the connection opts out, because its driver otherwise sends the password in cleartext.

No sentence says Oracle, MongoDB or Redis ignore the panel.

How to fix

  1. Read README.md:383 and README_es.md:190. The Spanish paragraph is already up to date and shows how the English one reads in translation.
  2. Rewrite the matching paragraph in README_ja.md:189, README_hi.md:191, README_ur.md:207 and README_pt.md:190 to carry the same facts. Keep the parts about the SSH tunnel and Kafka, which are already correct.
  3. In README_ur.md, keep the <span dir="rtl"> wrapper around the paragraph.

How to check

grep -n 'Oracle、MongoDB、Redisはこの設定を無視\|Oracle, MongoDB और Redis इस setting\|Oracle، MongoDB اور Redis اس option\|Oracle, MongoDB e Redis ignoram' README_ja.md README_hi.md README_ur.md README_pt.md
sed -n '189p' README_ja.md | grep -c libSQL
sed -n '191p' README_hi.md | grep -c libSQL
sed -n '207p' README_ur.md | grep -c libSQL
sed -n '190p' README_pt.md | grep -c libSQL
bun run readme:check

The first grep should print nothing. Each sed | grep -c should print 1 (adjust the line number if your edit moved the paragraph). readme:check does not read this paragraph, so it passes before and after; run it to make sure nothing else broke.

Backlog

This is entry DOC7 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.