Skip to content

Commit

Permalink
Merge branch 'main' into wyx/resolve_51
Browse files Browse the repository at this point in the history
Signed-off-by: IrisWan <[email protected]>
  • Loading branch information
WanYixian authored Nov 20, 2024
2 parents 62a8e80 + c79c5a4 commit 86cacab
Show file tree
Hide file tree
Showing 212 changed files with 1,110 additions and 1,146 deletions.
56 changes: 56 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: spellcheck
on:
pull_request:

jobs:
run:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: typos-action
id: typos-output
uses: crate-ci/[email protected]
with:
config: ./typos.toml

- name: Find Comment
if: ${{ failure() }}
uses: peter-evans/find-comment@v3
id: find-comment
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: "github-actions[bot]"
body-includes: The CI check for spelling has failed

- name: Create comment on PR if typos fail
if: ${{ failure() && steps.find-comment.outputs.comment-id == '' }}
uses: peter-evans/create-or-update-comment@v4
with:
issue-number: ${{ github.event.pull_request.number }}
body: |
### CI Check Failed
The CI check for spelling has failed. Please review the errors and correct any spelling mistakes.
For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues.
- name: Update comment if typos fail
if: ${{ failure() && steps.find-comment.outputs.comment-id != '' }}
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.find-comment.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
### CI Check Failed
The CI check for spelling has failed. Please review the errors and correct any spelling mistakes.
For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues.
edit-mode: replace

- name: Check Spelling
uses: rojopolis/[email protected]
with:
config_path: .spellcheck.yml
task_name: Markdown
23 changes: 23 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
matrix:
- name: Markdown
apsell:
ignore-case: true
lang: en
dictionary:
wordlists:
- .wordlist.txt
output: wordlist.dic
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- "*.mdx"
- "*.md"
default_encoding: utf-8
229 changes: 229 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
https
github
risingwavelabs
RisingWave
Redpanda
Kinesis
Astra
Debezium
debezium
JSON
struct
varchar
TabItem
RailroadDiagram
rr
SSL
SASL
OAUTHBEARER
Docusaurus
docusaurus
Postgres
postgres
datagen
Grafana
Etcd
MinIO
CMake
OpenSSL
psql
RiseDev
Tmux
Kubernetes
frontend
NodePort
kubectl
uptime
Avro
Protobuf
Prebuilt
Observability
CSV
DML
Alluxio
Superset
DBeaver
Jupyter
Metabase
Clickhouse
CockroachDB
DataStax
Pinot
TiDB
Hudi
Trino
Airbyte
Fivetran
Hightouch
dbt
ELT
ETL
DataStax
StreamNative
integrations
macOS
quickstart
substring
substrings
gz
dev
CTEs
namespace
deserialization
scalability
changelog
failover
risingwave
sql
js
rw
pgwire
json
mv
mysql
Redash
JDBC
Redash
analytics
Flink
JVM
APIs
stateful
runtime
disaggregated
PrivateLink
VPCs
VPC
DataSet
FlinkSQL
LSM
natively
ad-hoc
hoc
RocksDB
checkpointing
checkpointed
UDF
APIs
DAGs
acyclic
MapReduce
dataflow
pipelined
RisingWave's
Redash
TiCDC
upsert
JSONB
boolean
Citus
CLI
Chandy
OpenDAL
WebHDFS
ChatGPT
clickstream
cryptocurrency
dataset
HDFS
flink
Flink's
Homebrew
IoT
Lamport
microservice
microservices
multibyte
protobuf
Protobuf
timestamptz
timestamptzs
unary
zstd
http
pre
toc
latencies
thoroughputs
VPC
bigint
bytea
TopN
UDFs
avro
kafka
Paimon
TPC
Greenplum
updateable
ClickHouse
JetStream
MSK
msk
NATS
ScyllaDB
OOM
DataGrip
PgAdmin
clickhouse
Supabase
BigQuery
transactional
OLAP
ksqlDB
backfilling
GraphQL
src
img
jpg
StarRocks
starrocks
md
Bytebase
GCS
gcs
faq
OLTP
Napa
superset
Napa
www
DDL
backfill
backfills
MVs
Nats
Psycopg
Datadog
Hasura
Liquibase
EMQX
HiveMQ
MQTT
RabbitMQ
Standalone's
localhost
prometheus
datasources
OpenSearch
codebase
Databricks
SDKs
RWUs
roadmap
terraform
Serverless
WASM
schemas
risingwavecloud
Rockset
personalization
DefaultButton
LightButton
VoteNotify
SharedMergeTree
JWT
TOML
mintlify
customizations
repo
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Note

This repository is now published to: https://risingwavelabs.mintlify.app/docs/current/intro/introduction, and will be switched to our documentation domain once all testing and customizations are completed.
This repository contains the latest RisingWave documentation. [The old repository](https://github.com/risingwavelabs/risingwave-docs) now hosts the archived documentation up to v2.0 of RisingWave.



Expand Down
2 changes: 1 addition & 1 deletion client-libraries/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here is an overview of the available options. We provide detailed example guides
This table will be continuously updated to ensure compatibility.

| Language | Driver | Latest tested version |
| ---------- | ------------------------------------------------------------------------------------------------------------ | --------------------- |
| :--------- | :----------------------------------------------------------------------------------------------------------- | :-------------------- |
| C | [libpq](https://www.postgresql.org/docs/current/libpq.html) | |
| C# (.NET) | [Npgsql](https://www.npgsql.org/) | 8.0.2 |
| Go | [pgx](https://pkg.go.dev/github.com/jackc/pgx/v5). See the [example guide](/client-libraries/go). | v5.4.3 |
Expand Down
8 changes: 4 additions & 4 deletions client-libraries/ruby.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ require 'pg'
conn = PG.connect(host: '127.0.0.1', port: 4566, dbname: 'dev', user: 'root')
```

:::note
<Note>

The `BasicTypeMapForResults` class isn't supported currently, you need to cast RisingWave types into Ruby types manually.

:::
</Note>

## Create a source

Expand Down Expand Up @@ -57,11 +57,11 @@ EOF
conn.exec(sql) # Execute the query.
```

:::note
<Note>

All the code examples in this guide include a section for connecting to RisingWave. If you perform multiple actions within one connection session, you do not need to repeat this section.

:::
</Note>


## Create a materialized view
Expand Down
2 changes: 1 addition & 1 deletion cloud/check-spending-details.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Check spending details"
descriptin: You can view the usage and the corresponding charges for each project during the ongoing billing period. You can also download a PDF version of the invoice for your records.
description: You can view the usage and the corresponding charges for each project during the ongoing billing period. You can also download a PDF version of the invoice for your records.
---

<Frame>
Expand Down
3 changes: 0 additions & 3 deletions cloud/check-status-and-metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,5 @@ The project details page includes:
* [Database users](/cloud/manage-database-users/)

<Tip>
**TIP**

To specify the time range of the metrics, go to the **Metrics** tab, and click on **Last 30 minutes** in the top right corner to customize your time range.

</Tip>
2 changes: 1 addition & 1 deletion cloud/choose-a-project-plan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Each project type is associated with the corresponding features, capabilities, r
Currently, RisingWave Cloud offers three types of projects: **Trial**, **Standard**, and **Advanced**. The table below describes a high-level comparison of features and restrictions across three project types.

| Service type | Trial | Standard | Advanced |
| ----------------- | --------------------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------- |
| :---------------- | :-------------------------------------------- | :--------------------------------------------------------------- | :---------------------------------------------- |
| Deployment type | Multi-tenancy deployment, single-node project | Multi-tenancy deployment, multi-node project | Multi-tenancy deployment, multi-node project |
| Description | Standalone deployment with 2-RWU resources. | Deployed on shared Kubernetes service with customized resources. | Customized project deployment based on requests |
| Pricing | Free | Pay-as-you-go | Customized, contact sales |
Expand Down
Loading

0 comments on commit 86cacab

Please sign in to comment.