From 6542f1c2326520fd90143a585bba66adc6777329 Mon Sep 17 00:00:00 2001 From: Nutomic Date: Thu, 24 Jun 2021 19:25:59 +0000 Subject: [PATCH] Add workaround for external link in sidebar, replace join.lemmy.ml (#85) * Add workaround to fix external link in sidebar (fixes #84) * Replace join.lemmy.ml with join-lemmy.org --- src/en/SUMMARY.md | 2 +- src/en/client_development/api_reference.md | 2 +- src/en/client_development/client_development.md | 2 +- src/en/client_development/http_api.md | 4 ++-- src/en/client_development/websocket_api.md | 1 + src/es/SUMMARY.md | 2 +- src/es/client_development/api_reference.md | 2 +- src/es/client_development/client_development.md | 2 +- src/es/client_development/http_api.md | 4 ++-- src/es/client_development/websocket_api.md | 1 + src/fr/SUMMARY.md | 2 +- src/fr/client_development/websocket_api.md | 1 + src/ru/SUMMARY.md | 2 +- src/ru/client_development/api_reference.md | 2 +- src/ru/client_development/client_development.md | 2 +- src/ru/client_development/websocket_api.md | 1 + 16 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 src/en/client_development/websocket_api.md create mode 100644 src/es/client_development/websocket_api.md create mode 100644 src/fr/client_development/websocket_api.md create mode 100644 src/ru/client_development/websocket_api.md diff --git a/src/en/SUMMARY.md b/src/en/SUMMARY.md index 411d7f8..fdbe39f 100644 --- a/src/en/SUMMARY.md +++ b/src/en/SUMMARY.md @@ -20,7 +20,7 @@ - [Client Development](client_development/client_development.md) - [Theming Guide](client_development/theming.md) - [API reference](client_development/api_reference.md) - - [WebSocket API](https://join.lemmy.ml/api/index.html) + - [WebSocket API](client_development/websocket_api.md) - [HTTP API](client_development/http_api.md) - [Creating a Custom Frontend](client_development/custom_frontend.md) - [Contributing](contributing/contributing.md) diff --git a/src/en/client_development/api_reference.md b/src/en/client_development/api_reference.md index f6436c0..8d4afab 100644 --- a/src/en/client_development/api_reference.md +++ b/src/en/client_development/api_reference.md @@ -1,7 +1,7 @@ # API reference Lemmy has two, intertwined APIs: -- [WebSocket](https://join.lemmy.ml/api/index.html) +- [WebSocket](https://join-lemmy.org/api/index.html) - [HTTP](http_api.md) This page describes concepts that are common to both. diff --git a/src/en/client_development/client_development.md b/src/en/client_development/client_development.md index a5e6fef..a6d67ba 100644 --- a/src/en/client_development/client_development.md +++ b/src/en/client_development/client_development.md @@ -2,5 +2,5 @@ - [Theming Guide](client_development/theming.md) - [API reference](client_development/api_reference.md) -- [WebSocket API](https://join.lemmy.ml/api/index.html) +- [WebSocket API](https://join-lemmy.org/api/index.html) - [HTTP API](client_development/http_api.md) \ No newline at end of file diff --git a/src/en/client_development/http_api.md b/src/en/client_development/http_api.md index f75e7e6..c522c0b 100644 --- a/src/en/client_development/http_api.md +++ b/src/en/client_development/http_api.md @@ -20,14 +20,14 @@ ## WebSocket vs HTTP API Lemmy's HTTP API is almost identical to its WebSocket API: -- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join.lemmy.ml/api/index.html) +- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join-lemmy.org/api/index.html) - **HTTP API** needs the form (data) at the top level, an HTTP operation (GET, PUT or POST) and endpoint (at `http(s)://host/api/v2/endpoint`). For example: > `POST {username_or_email: X, password: X}` For more information, see the [http.ts](https://github.com/LemmyNet/lemmy-js-client/blob/main/src/http.ts) file. -[The WebSocket API](https://join.lemmy.ml/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls. +[The WebSocket API](https://join-lemmy.org/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls. ## Examples diff --git a/src/en/client_development/websocket_api.md b/src/en/client_development/websocket_api.md new file mode 100644 index 0000000..1bd735d --- /dev/null +++ b/src/en/client_development/websocket_api.md @@ -0,0 +1 @@ +# [WebSocket API](https://join-lemmy.org/api/index.html) diff --git a/src/es/SUMMARY.md b/src/es/SUMMARY.md index a8817fa..b3c48fb 100644 --- a/src/es/SUMMARY.md +++ b/src/es/SUMMARY.md @@ -20,7 +20,7 @@ - [Client Development](client_development/client_development.md) - [Theming Guide](client_development/theming.md) - [API reference](client_development/api_reference.md) - - [WebSocket API](https://join.lemmy.ml/api/index.html) + - [WebSocket API](client_development/websocket_api.md) - [HTTP API](client_development/http_api.md) - [Creating a Custom Frontend](client_development/custom_frontend.md) - [Contributing](contributing/contributing.md) diff --git a/src/es/client_development/api_reference.md b/src/es/client_development/api_reference.md index f6436c0..8d4afab 100644 --- a/src/es/client_development/api_reference.md +++ b/src/es/client_development/api_reference.md @@ -1,7 +1,7 @@ # API reference Lemmy has two, intertwined APIs: -- [WebSocket](https://join.lemmy.ml/api/index.html) +- [WebSocket](https://join-lemmy.org/api/index.html) - [HTTP](http_api.md) This page describes concepts that are common to both. diff --git a/src/es/client_development/client_development.md b/src/es/client_development/client_development.md index a5e6fef..a6d67ba 100644 --- a/src/es/client_development/client_development.md +++ b/src/es/client_development/client_development.md @@ -2,5 +2,5 @@ - [Theming Guide](client_development/theming.md) - [API reference](client_development/api_reference.md) -- [WebSocket API](https://join.lemmy.ml/api/index.html) +- [WebSocket API](https://join-lemmy.org/api/index.html) - [HTTP API](client_development/http_api.md) \ No newline at end of file diff --git a/src/es/client_development/http_api.md b/src/es/client_development/http_api.md index f75e7e6..c522c0b 100644 --- a/src/es/client_development/http_api.md +++ b/src/es/client_development/http_api.md @@ -20,14 +20,14 @@ ## WebSocket vs HTTP API Lemmy's HTTP API is almost identical to its WebSocket API: -- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join.lemmy.ml/api/index.html) +- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join-lemmy.org/api/index.html) - **HTTP API** needs the form (data) at the top level, an HTTP operation (GET, PUT or POST) and endpoint (at `http(s)://host/api/v2/endpoint`). For example: > `POST {username_or_email: X, password: X}` For more information, see the [http.ts](https://github.com/LemmyNet/lemmy-js-client/blob/main/src/http.ts) file. -[The WebSocket API](https://join.lemmy.ml/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls. +[The WebSocket API](https://join-lemmy.org/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls. ## Examples diff --git a/src/es/client_development/websocket_api.md b/src/es/client_development/websocket_api.md new file mode 100644 index 0000000..1bd735d --- /dev/null +++ b/src/es/client_development/websocket_api.md @@ -0,0 +1 @@ +# [WebSocket API](https://join-lemmy.org/api/index.html) diff --git a/src/fr/SUMMARY.md b/src/fr/SUMMARY.md index 0d454ba..655a41d 100644 --- a/src/fr/SUMMARY.md +++ b/src/fr/SUMMARY.md @@ -20,7 +20,7 @@ - [Client Development](client_development/client_development.md) - [Theming Guide](client_development/theming.md) - [API reference](client_development/api_reference.md) - - [WebSocket API](https://join.lemmy.ml/api/index.html) + - [WebSocket API](client_development/websocket_api.md) - [HTTP API](client_development/http_api.md) - [Creating a Custom Frontend](client_development/custom_frontend.md) - [Contributing](contributing/contributing.md) diff --git a/src/fr/client_development/websocket_api.md b/src/fr/client_development/websocket_api.md new file mode 100644 index 0000000..1bd735d --- /dev/null +++ b/src/fr/client_development/websocket_api.md @@ -0,0 +1 @@ +# [WebSocket API](https://join-lemmy.org/api/index.html) diff --git a/src/ru/SUMMARY.md b/src/ru/SUMMARY.md index 970faf2..f894537 100644 --- a/src/ru/SUMMARY.md +++ b/src/ru/SUMMARY.md @@ -20,7 +20,7 @@ - [Разработка Клиентов](client_development/client_development.md) - [Руководство по темам](client_development/theming.md) - [Справочник по API](client_development/api_reference.md) - - [WebSocket API](https://join.lemmy.ml/api/index.html) + - [WebSocket API](client_development/websocket_api.md) - [HTTP API](client_development/http_api.md) - [Создание пользовательского интерфейса](client_development/custom_frontend.md) - [Вклад](contributing/contributing.md) diff --git a/src/ru/client_development/api_reference.md b/src/ru/client_development/api_reference.md index 846d960..2bff266 100644 --- a/src/ru/client_development/api_reference.md +++ b/src/ru/client_development/api_reference.md @@ -1,7 +1,7 @@ # Справочник по API Lemmy имеет два взаимосвязанных API: -- [WebSocket (анг.язык)](https://join.lemmy.ml/api/index.html) +- [WebSocket (анг.язык)](https://join-lemmy.org/api/index.html) - [HTTP (анг.язык)](http_api.md) На этой странице описаны общие для них концепции. diff --git a/src/ru/client_development/client_development.md b/src/ru/client_development/client_development.md index 94f0291..ddd7d94 100644 --- a/src/ru/client_development/client_development.md +++ b/src/ru/client_development/client_development.md @@ -2,5 +2,5 @@ - [Тематическое руководство ](client_development/theming.md) - [Справочник по API](client_development/api_reference.md) -- [WebSocket API](https://join.lemmy.ml/api/index.html) +- [WebSocket API](https://join-lemmy.org/api/index.html) - [HTTP API](client_development/http_api.md) diff --git a/src/ru/client_development/websocket_api.md b/src/ru/client_development/websocket_api.md new file mode 100644 index 0000000..1bd735d --- /dev/null +++ b/src/ru/client_development/websocket_api.md @@ -0,0 +1 @@ +# [WebSocket API](https://join-lemmy.org/api/index.html)