Skip to content

Commit

Permalink
Docusaurus 3 (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
FZambia authored Dec 31, 2023
1 parent 1f090f4 commit 987129b
Show file tree
Hide file tree
Showing 13 changed files with 4,980 additions and 34,472 deletions.
2 changes: 1 addition & 1 deletion docs/pro/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Returns information about active connections according to the request.
| -------------- | -------------- | ------ | ------------ |
| channels | `map[string]ChannelContext` | yes | Channels client subscribed to |
| connection_token | ConnectionTokenInfo | yes | information about connection token |
| subscription_tokens | map<string, SubscriptionTokenInfo> | yes | information about channel tokens used to subscribe |
| subscription_tokens | `map<string, SubscriptionTokenInfo>` | yes | information about channel tokens used to subscribe |
| meta | JSON object | yes | meta information attached to a connection |

#### ChannelContext object
Expand Down
2 changes: 1 addition & 1 deletion docs/pro/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Centrifugo PRO is packed with the following features:
* 🔍 [Channel and user tracing](./tracing.md) allows watching client protocol frames in channel or per user ID in real time.
* 💹 [Real-time analytics with ClickHouse](./analytics.md) for a great system observability, reporting and trending.
* 🛡️ [Operation rate limits](./rate_limiting.md) to protect server from the real-time API misusing and frontend bugs.
<!-- * 🌐 [Distributed rate limit API](./distributed_rate_limit.md) provides a generic way to implement high-precision rate limiting in your app. -->
* 🔥 [Push notification API](./push_notifications.md) to manage device tokens and send mobile and browser push notifications.
* 🟢 [User status API](./user_status.md) feature allows understanding activity state for a list of users.
* 🔌 [Connections API](./connections.md) to query, filter and inspect active connections.
Expand All @@ -32,6 +31,7 @@ Centrifugo PRO is packed with the following features:
* 🍔 [Message batching control](./client_msg_batching.md) for advanced tuning of client connection write behaviour.
* 🧐 [Observability enhancements](./observability_enhancements.md) for additional more granular system state insights.
* 🪵 [CPU and RSS memory](./process_stats.md) usage stats of Centrifugo nodes in admin UI.
<!-- * 🌐 [Distributed rate limit API](./distributed_rate_limit.md) provides a generic way to implement high-precision rate limiting in your app. -->

Also, explore our [Centrifugo PRO planned features](https://github.com/orgs/centrifugal/projects/3/views/1) board for a concise overview of upcoming features which are currently in progress and enhancements planned for a future.

Expand Down
8 changes: 4 additions & 4 deletions docs/pro/push_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Registers or updates device information.
| `platform` | string | Yes | Platform of the device (valid choices: `ios`, `android`, `web`). |
| `user` | string | No | User associated with the device. |
| `topics` | array of strings | No | Device topic subscriptions. This should be a full list which replaces all the topics previously accociated with the device. User topics managed by `UserTopic` model will be automatically attached. |
| `meta` | map<string, string> | No | Additional custom metadata for the device |
| `meta` | `map<string, string>` | No | Additional custom metadata for the device |

#### device_register result

Expand Down Expand Up @@ -270,7 +270,7 @@ Call this method to update device. For example, when user logs out the app and y

| Field | Type | Required | Description |
|-----------------|----------|----|---------------------------------------------|
| `meta` | map<string, string> | Yes | Meta to set |
| `meta` | `map<string, string>` | Yes | Meta to set |

`DeviceTopicsUpdate`:

Expand Down Expand Up @@ -341,7 +341,7 @@ Returns a paginated list of registered devices according to request filter condi
| `platform` | string | Yes | The device's platform. |
| `user` | string | No | The user associated with the device. |
| `topics` | array of strings | No | Only included if `include_topics` was true |
| `meta` | map<string, string> | No | Only included if `include_meta` was true |
| `meta` | `map<string, string>` | No | Only included if `include_meta` was true |

### device_topic_update

Expand Down Expand Up @@ -504,7 +504,7 @@ Send push notification to specific `device_ids`, or to `topics`, or native provi

| Field | Type | Required | Description |
|---------------|-----------|-----------|--------|
| `headers` | map<string, string> | No | APNs [headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) |
| `headers` | `map<string, string>` | No | APNs [headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) |
| `payload` | JSON object | Yes | APNs [payload](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification) |

#### send_push_notification result
Expand Down
8 changes: 4 additions & 4 deletions docs/transports/client_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -769,19 +769,19 @@ Errors with codes 0-100 can be used by client-side implementation. Client-side e

## Unsubscribe codes

Server may return unsubscribe codes. Server unsubscribe codes must be in range [2000, 2999].
Server may return unsubscribe codes. Server unsubscribe codes must be in range `[2000, 2999]`.

Unsubscribe codes >= 2500 coming from server to client result into automatic resubscribe attempt (i.e. client goes to `subscribing` state). Codes < 2500 result into going to `unsubscribed` state.

Client implementation can use codes <2000 for client-side specific unsubscribe reasons.
Client implementation can use codes < 2000 for client-side specific unsubscribe reasons.

## Disconnect codes

Server may send custom disconnect codes to a client. Custom disconnect codes must be in range [3000, 4999].
Server may send custom disconnect codes to a client. Custom disconnect codes must be in range `[3000, 4999]`.

Client automatically reconnects upon receiving code in range 3000-3499, 4000-4499 (i.e. Client goes to `connecting` state). Other codes result into going to `disconnected` state.

Client implementation can use codes <3000 for client-side specific disconnect reasons.
Client implementation can use codes < 3000 for client-side specific disconnect reasons.

## RPC

Expand Down
14 changes: 3 additions & 11 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -234,28 +234,20 @@ module.exports = {
* If feedOptions is undefined, no rss feed will be generated.
*/
feedOptions: {
limit: false,
type: 'all', // required. 'rss' | 'feed' | 'all'
title: '', // default to siteConfig.title
description: '', // default to `${siteConfig.title} Blog`
copyright: 'Centrifugal',
copyright: 'Centrifugal Labs LTD',
language: undefined, // possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
},
},
theme: {
customCss: require.resolve("./src/css/custom.scss"),
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
plugins: [
[
require.resolve("@easyops-cn/docusaurus-search-local"),
{
hashed: true,
},
],
"docusaurus-plugin-sass",
],
stylesheets: [
'https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css'
]
Expand Down
Loading

0 comments on commit 987129b

Please sign in to comment.