From 362958ff1ff8bb539ebeaf7f6e6c825f480b7552 Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Fri, 22 Oct 2021 18:41:39 +0200 Subject: [PATCH] use defaults.hjson from lemmy without building, also include apub examples --- .drone.yml | 8 +- .gitignore | 2 +- README.md | 3 +- build.sh | 19 ---- lemmy | 2 +- src/en/administration/configuration.md | 2 +- src/en/client_development/http_api.md | 1 + src/en/federation/lemmy_protocol.md | 134 +------------------------ 8 files changed, 15 insertions(+), 156 deletions(-) delete mode 100755 build.sh create mode 100644 src/en/client_development/http_api.md diff --git a/.drone.yml b/.drone.yml index cf8c9c5..17cc929 100644 --- a/.drone.yml +++ b/.drone.yml @@ -9,8 +9,8 @@ steps: - git submodule update --recursive --remote - name: check documentation build - image: rust:1.55-slim-buster + image: rust:1.49-slim-buster commands: - - apt update - - apt install pkg-config libssl-dev libpq-dev --yes - - ./build.sh + - cargo install mdbook --git https://github.com/Nutomic/mdBook.git --branch localization + --rev 0982a82 --force --debug + - mdbook build . diff --git a/.gitignore b/.gitignore index 75dc1b9..4af85eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ book generated node_modules -.idea \ No newline at end of file +.idea diff --git a/README.md b/README.md index a6b5418..3279b13 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ You need to have [Cargo](https://doc.rust-lang.org/cargo/) installed. Our documentation tool [mdbook](https://github.com/rust-lang/mdBook) doesn't support localisation yet, so we are using code that is still work on progress to create our documentation with localisation. Note that this code still has some rough edges. See [github.com/rust-lang/mdBook/pull/1306](https://github.com/rust-lang/mdBook/pull/1306) for more details. ```bash -./build.sh +cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git \ + --branch localization --rev d06249b # generate static page in `book` subfolder mdbook build # serve the book at `http://localhost:3000`, and rebuilds on changes diff --git a/build.sh b/build.sh deleted file mode 100755 index 8ce76e4..0000000 --- a/build.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/bash -set -e - -# generate config docs -pushd lemmy -mkdir -p ../generated -cargo run -- --print-config-docs >> ../generated/config.hjson -# replace // comments with # -sed -i "s/\/\//#/" ../generated/config.hjson -# remove trailing commas -sed -i "s/,\$//" ../generated/config.hjson -# remove quotes around json keys -sed -i "s/\"//" ../generated/config.hjson -sed -i "s/\"//" ../generated/config.hjson -popd - -cargo install mdbook --git https://github.com/Nutomic/mdBook.git --branch localization \ - --rev 0982a82 -mdbook build . diff --git a/lemmy b/lemmy index f4c783c..149a4e0 160000 --- a/lemmy +++ b/lemmy @@ -1 +1 @@ -Subproject commit f4c783cba5b3363508b8b0bc1c042f6dc835a8d6 +Subproject commit 149a4e0de88f82b6378c044423bf7d628108fc86 diff --git a/src/en/administration/configuration.md b/src/en/administration/configuration.md index 9e8f226..ca955a5 100644 --- a/src/en/administration/configuration.md +++ b/src/en/administration/configuration.md @@ -16,5 +16,5 @@ cd server ## Full config with default values ```hjson -{{#include ../../../generated/config.hjson}} +{{#include ../../../lemmy/config/defaults.hjson}} ``` \ No newline at end of file diff --git a/src/en/client_development/http_api.md b/src/en/client_development/http_api.md new file mode 100644 index 0000000..301012c --- /dev/null +++ b/src/en/client_development/http_api.md @@ -0,0 +1 @@ +# HTTP API diff --git a/src/en/federation/lemmy_protocol.md b/src/en/federation/lemmy_protocol.md index 813459f..c58eee3 100644 --- a/src/en/federation/lemmy_protocol.md +++ b/src/en/federation/lemmy_protocol.md @@ -84,42 +84,7 @@ Sends activities to user: `Accept/Follow`, `Announce` Receives activities from user: `Follow`, `Undo/Follow`, `Create`, `Update`, `Like`, `Dislike`, `Remove` (only admin/mod), `Delete` (only creator), `Undo` (only for own actions) ```json -{ - "@context": ..., - "id": "https://enterprise.lemmy.ml/c/main", - "type": "Group", - "preferredUsername": "main", - "name": "The Main Community", - "sensitive": false, - "content": "Welcome to the default community!", - "mediaType": "text/html", - "source": { - "content": "Welcome to the default community!", - "mediaType": "text/markdown" - }, - "icon": { - "type": "Image", - "url": "https://enterprise.lemmy.ml/pictrs/image/Z8pFFb21cl.png" - }, - "image": { - "type": "Image", - "url": "https://enterprise.lemmy.ml/pictrs/image/Wt8zoMcCmE.jpg" - }, - "inbox": "https://enterprise.lemmy.ml/c/main/inbox", - "outbox": "https://enterprise.lemmy.ml/c/main/outbox", - "followers": "https://enterprise.lemmy.ml/c/main/followers", - "moderators": "https://enterprise.lemmy.ml/c/main/moderators", - "endpoints": { - "sharedInbox": "https://enterprise.lemmy.ml/inbox" - }, - "published": "2020-10-06T17:27:43.282386+00:00", - "updated": "2020-10-08T11:57:50.545821+00:00", - "publicKey": { - "id": "https://enterprise.lemmy.ml/c/main#main-key", - "owner": "https://enterprise.lemmy.ml/c/main", - "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA9JJ7Ybp/H7iXeLkWFepg\ny4PHyIXY1TO9rK3lIBmAjNnkNywyGXMgUiiVhGyN9yU7Km8aWayQsNHOkPL7wMZK\nnY2Q+CTQv49kprEdcDVPGABi6EbCSOcRFVaUjjvRHf9Olod2QP/9OtX0oIFKN2KN\nPIUjeKK5tw4EWB8N1i5HOuOjuTcl2BXSemCQLAlXerLjT8xCarGi21xHPaQvAuns\nHt8ye7fUZKPRT10kwDMapjQ9Tsd+9HeBvNa4SDjJX1ONskNh2j4bqHHs2WUymLpX\n1cgf2jmaXAsz6jD9u0wfrLPelPJog8RSuvOzDPrtwX6uyQOl5NK00RlBZwj7bMDx\nzwIDAQAB\n-----END PUBLIC KEY-----\n" - } -} +{{#include ../../../lemmy/crates/apub/assets/lemmy-community.json}} ``` | Field Name | Mandatory | Description | @@ -194,38 +159,7 @@ Receives activities from Community: `Accept/Follow`, `Announce` Sends and receives activities from/to other users: `Create/Note`, `Update/Note`, `Delete/Note`, `Undo/Delete/Note` (all those related to private messages) ```json -{ - "@context": ..., - "id": "https://enterprise.lemmy.ml/u/picard", - "type": "Person", - "preferredUsername": "picard", - "name": "Jean-Luc Picard", - "content": "The user bio", - "mediaType": "text/html", - "source": { - "content": "The user bio", - "mediaType": "text/markdown" - }, - "icon": { - "type": "Image", - "url": "https://enterprise.lemmy.ml/pictrs/image/DS3q0colRA.jpg" - }, - "image": { - "type": "Image", - "url": "https://enterprise.lemmy.ml/pictrs/image/XenaYI5hTn.png" - }, - "inbox": "https://enterprise.lemmy.ml/u/picard/inbox", - "endpoints": { - "sharedInbox": "https://enterprise.lemmy.ml/inbox" - }, - "published": "2020-10-06T17:27:43.234391+00:00", - "updated": "2020-10-08T11:27:17.905625+00:00", - "publicKey": { - "id": "https://enterprise.lemmy.ml/u/picard#main-key", - "owner": "https://enterprise.lemmy.ml/u/picard", - "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyH9iH83+idw/T4QpuRSY\n5YgQ/T5pJCNxvQWb6qcCu3gEVigfbreqZKJpOih4YT36wu4GjPfoIkbWJXcfcEzq\nMEQoYbPStuwnklpN2zj3lRIPfGLht9CAlENLWikTUoW5kZLyU6UQtOGdT2b1hDuK\nsUEn67In6qYx6pal8fUbO6X3O2BKzGeofnXgHCu7QNIuH4RPzkWsLhvwqEJYP0zG\nodao2j+qmhKFsI4oNOUCGkdJejO7q+9gdoNxAtNNKilIOwUFBYXeZJb+XGlzo0X+\n70jdJ/xQCPlPlItU4pD/0FwPLtuReoOpMzLi20oDsPXJBvn+/NJaxqDINuywcN5p\n4wIDAQAB\n-----END PUBLIC KEY-----\n" - } -} +{{#include ../../../lemmy/crates/apub/assets/lemmy-person.json}} ``` | Field Name | Mandatory | Description | @@ -262,33 +196,7 @@ The user inbox is not actually implemented yet, and is only a placeholder for Ac A page with title, and optional URL and text content. The URL often leads to an image, in which case a thumbnail is included. Each post belongs to exactly one community. ```json -{ - "@context": ..., - "id": "https://voyager.lemmy.ml/post/29", - "type": "Page", - "attributedTo": "https://voyager.lemmy.ml/u/picard", - "to": [ - "https://voyager.lemmy.ml/c/main", - "https://www.w3.org/ns/activitystreams#Public" - ], - "name": "Test thumbnail 2", - "content": "blub blub", - "mediaType": "text/html", - "source": { - "content": "blub blub", - "mediaType": "text/markdown" - }, - "url": "https://voyager.lemmy.ml:/pictrs/image/fzGwCsq7BJ.jpg", - "image": { - "type": "Image", - "url": "https://voyager.lemmy.ml/pictrs/image/UejwBqrJM2.jpg" - }, - "commentsEnabled": true, - "sensitive": false, - "stickied": false, - "published": "2020-09-24T17:42:50.396237+00:00", - "updated": "2020-09-24T18:31:14.158618+00:00" -} +{{#include ../../../lemmy/crates/apub/assets/lemmy-post.json}} ``` | Field Name | Mandatory | Description | @@ -310,25 +218,7 @@ A page with title, and optional URL and text content. The URL often leads to an A reply to a post, or reply to another comment. Contains only text (including references to other users or communities). Lemmy displays comments in a tree structure. ```json -{ - "@context": ..., - "id": "https://enterprise.lemmy.ml/comment/95", - "type": "Note", - "attributedTo": "https://enterprise.lemmy.ml/u/picard", - "to": "https://www.w3.org/ns/activitystreams#Public", - "content": "mmmk", - "mediaType": "text/html", - "source": { - "content": "mmmk", - "mediaType": "text/markdown" - }, - "inReplyTo": [ - "https://enterprise.lemmy.ml/post/38", - "https://voyager.lemmy.ml/comment/73" - ], - "published": "2020-10-06T17:53:22.174836+00:00", - "updated": "2020-10-06T17:53:22.174836+00:00" -} +{{#include ../../../lemmy/crates/apub/assets/lemmy-comment.json}} ``` | Field Name | Mandatory | Description | @@ -345,21 +235,7 @@ A reply to a post, or reply to another comment. Contains only text (including re A direct message from one user to another. Can not include additional users. Threading is not implemented yet, so the `inReplyTo` field is missing. ```json -{ - "@context": ..., - "id": "https://enterprise.lemmy.ml/private_message/34", - "type": "Note", - "attributedTo": "https://enterprise.lemmy.ml/u/picard", - "to": "https://voyager.lemmy.ml/u/janeway", - "content": "test", - "source": { - "content": "test", - "mediaType": "text/markdown" - }, - "mediaType": "text/markdown", - "published": "2020-10-08T19:10:46.542820+00:00", - "updated": "2020-10-08T20:13:52.547156+00:00" -} +{{#include ../../../lemmy/crates/apub/assets/lemmy-private-message.json}} ``` | Field Name | Mandatory | Description |