LemmyNet/lemmy-docs
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2024-11-24 05:11:09 +00:00
Code Issues Projects Releases Wiki Activity

Download embeds over http instead of using git submodule

Browse source
This commit is contained in:
Felix Ableitner 2021-10-25 12:13:19 +02:00
parent 580f344643
commit 5fca90c9ab
8 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.drone.yml
View file

@ -13,4 +13,5 @@ steps:
commands:
- cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git --branch localization
--rev 9d8147c --force --debug
- ./update-includes.sh
- mdbook build .

2
.gitignore vendored
View file

@ -1,4 +1,4 @@
book
generated
include
node_modules
.idea

3
.gitmodules vendored
View file

@ -1,3 +0,0 @@
[submodule "lemmy"]
path = lemmy
url = https://github.com/LemmyNet/lemmy.git

1
README.md
View file

@ -11,6 +11,7 @@ Our documentation tool [mdbook](https://github.com/rust-lang/mdBook) doesn't sup
```bash
cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git \
--branch localization --rev 9d8147c
./update-includes.sh
# generate static page in `book` subfolder
mdbook build
# serve the book at `http://localhost:3000`, and rebuilds on changes

1
lemmy

@ -1 +0,0 @@
Subproject commit 149a4e0de88f82b6378c044423bf7d628108fc86

2
src/en/administration/configuration.md
View file

@ -16,5 +16,5 @@ cd server
## Full config with default values
```hjson
{{#include ../../../lemmy/config/defaults.hjson}}
{{#include ../../../include/config/defaults.hjson}}
```

10
src/en/federation/lemmy_protocol.md
View file

@ -84,7 +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
{{#include ../../../lemmy/crates/apub/assets/lemmy-community.json}}
{{#include ../../../include/activitypub/lemmy-community.json}}
```
| Field Name | Mandatory | Description |
@ -159,7 +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
{{#include ../../../lemmy/crates/apub/assets/lemmy-person.json}}
{{#include ../../../include/activitypub/lemmy-person.json}}
```
| Field Name | Mandatory | Description |
@ -196,7 +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
{{#include ../../../lemmy/crates/apub/assets/lemmy-post.json}}
{{#include ../../../include/activitypub/lemmy-post.json}}
```
| Field Name | Mandatory | Description |
@ -218,7 +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
{{#include ../../../lemmy/crates/apub/assets/lemmy-comment.json}}
{{#include ../../../include/activitypub/lemmy-comment.json}}
```
| Field Name | Mandatory | Description |
@ -235,7 +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
{{#include ../../../lemmy/crates/apub/assets/lemmy-private-message.json}}
{{#include ../../../include/activitypub/lemmy-private-message.json}}
```
| Field Name | Mandatory | Description |

14
update-includes.sh Executable file
View file

@ -0,0 +1,14 @@
#!/bin/bash
set -e
mkdir -p include/config
mkdir -p include/activitypub
cd include/config
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/config/defaults.hjson -o defaults.hjson
cd ../activitypub
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-person.json -o lemmy-person.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-community.json -o lemmy-community.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-post.json -o lemmy-post.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-comment.json -o lemmy-comment.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-private-message.json -o lemmy-private-message.json