From ba49560e001110b138e455aa7cd161d6fff6532e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:13 -0700 Subject: [PATCH 0001/4057] New translations activitypub.md (Romanian) --- locale/ro_RO/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ro_RO/content/codebase/activitypub.md diff --git a/locale/ro_RO/content/codebase/activitypub.md b/locale/ro_RO/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ro_RO/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 7dd33eb45f04b6f8a46d3e9fd70062bbb903096e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:14 -0700 Subject: [PATCH 0002/4057] New translations permissions.md (Spanish) --- locale/es_ES/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/es_ES/content/codebase/permissions.md diff --git a/locale/es_ES/content/codebase/permissions.md b/locale/es_ES/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/es_ES/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 90fac9cb03614c7e006e08be4b01af35c5f6e50a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:15 -0700 Subject: [PATCH 0003/4057] New translations activitypub.md (Chinese Traditional) --- .../zh_Hant/content/codebase/activitypub.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/zh_Hant/content/codebase/activitypub.md diff --git a/locale/zh_Hant/content/codebase/activitypub.md b/locale/zh_Hant/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/zh_Hant/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 3184cf477a2feb994679b1a18ae976e53b1aacc5 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:16 -0700 Subject: [PATCH 0004/4057] New translations activitypub.md (Vietnamese) --- locale/vi_VN/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/vi_VN/content/codebase/activitypub.md diff --git a/locale/vi_VN/content/codebase/activitypub.md b/locale/vi_VN/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/vi_VN/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 163502a5ac75e9809c8d78fb6e9044340be281fd Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:17 -0700 Subject: [PATCH 0005/4057] New translations activitypub.md (Galician) --- locale/gl_ES/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/gl_ES/content/codebase/activitypub.md diff --git a/locale/gl_ES/content/codebase/activitypub.md b/locale/gl_ES/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/gl_ES/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 6547fe242e0cd2b9cc030f787e7963b28e1c6abc Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:18 -0700 Subject: [PATCH 0006/4057] New translations activitypub.md (Portuguese, Brazilian) --- locale/pt_BR/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/pt_BR/content/codebase/activitypub.md diff --git a/locale/pt_BR/content/codebase/activitypub.md b/locale/pt_BR/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/pt_BR/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 1837743d733dbb85cfe668540d5e67e60aa8b44d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:19 -0700 Subject: [PATCH 0007/4057] New translations activitypub.md (Welsh) --- locale/cy_GB/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/cy_GB/content/codebase/activitypub.md diff --git a/locale/cy_GB/content/codebase/activitypub.md b/locale/cy_GB/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/cy_GB/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From a728e13ceb2a3b8eb4e59a30cf6670d1dbe40df2 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:20 -0700 Subject: [PATCH 0008/4057] New translations activitypub.md (Oulipo) --- .../en_Oulipo/content/codebase/activitypub.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/en_Oulipo/content/codebase/activitypub.md diff --git a/locale/en_Oulipo/content/codebase/activitypub.md b/locale/en_Oulipo/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/en_Oulipo/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 6496827c5d401cb9531663177b778e8b21cfdc6c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:21 -0700 Subject: [PATCH 0009/4057] New translations activitypub.md (Eastern Min) --- locale/cdo/content/codebase/activitypub.md | 58 ++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/cdo/content/codebase/activitypub.md diff --git a/locale/cdo/content/codebase/activitypub.md b/locale/cdo/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/cdo/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From b9f57dde3bafcbb65a2800c85d86c51a72a1f209 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:21 -0700 Subject: [PATCH 0010/4057] New translations permissions.md (Romanian) --- locale/ro_RO/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ro_RO/content/codebase/permissions.md diff --git a/locale/ro_RO/content/codebase/permissions.md b/locale/ro_RO/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ro_RO/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From ae59188cce7f6be06fd913916564bfac442a2b4e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:22 -0700 Subject: [PATCH 0011/4057] New translations permissions.md (French) --- locale/fr_FR/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/fr_FR/content/codebase/permissions.md diff --git a/locale/fr_FR/content/codebase/permissions.md b/locale/fr_FR/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/fr_FR/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 95449c882dd602d6555e040b978d2b6201e0f7f4 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:23 -0700 Subject: [PATCH 0012/4057] New translations permissions.md (Afrikaans) --- locale/af_ZA/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/af_ZA/content/codebase/permissions.md diff --git a/locale/af_ZA/content/codebase/permissions.md b/locale/af_ZA/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/af_ZA/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 9bb9df5a1207d043387bb02eabcc3ea92ce779c9 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:24 -0700 Subject: [PATCH 0013/4057] New translations activitypub.md (Ukrainian) --- locale/uk_UA/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/uk_UA/content/codebase/activitypub.md diff --git a/locale/uk_UA/content/codebase/activitypub.md b/locale/uk_UA/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/uk_UA/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From d7ed027b017002e46b558437b9d686884528f99b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:25 -0700 Subject: [PATCH 0014/4057] New translations permissions.md (Arabic) --- locale/ar_SA/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ar_SA/content/codebase/permissions.md diff --git a/locale/ar_SA/content/codebase/permissions.md b/locale/ar_SA/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ar_SA/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 8818f949e3d9c85fb848ee46cb9b306d0888a0ee Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:26 -0700 Subject: [PATCH 0015/4057] New translations permissions.md (Catalan) --- locale/ca_ES/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ca_ES/content/codebase/permissions.md diff --git a/locale/ca_ES/content/codebase/permissions.md b/locale/ca_ES/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ca_ES/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 3f18a9968f715d629fce51176b1445a1f2639c44 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:27 -0700 Subject: [PATCH 0016/4057] New translations permissions.md (Czech) --- locale/cs_CZ/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/cs_CZ/content/codebase/permissions.md diff --git a/locale/cs_CZ/content/codebase/permissions.md b/locale/cs_CZ/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/cs_CZ/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From e7eb291ea1d7c7d70ac6e26219a5952b1392dde1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:28 -0700 Subject: [PATCH 0017/4057] New translations permissions.md (Danish) --- locale/da_DK/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/da_DK/content/codebase/permissions.md diff --git a/locale/da_DK/content/codebase/permissions.md b/locale/da_DK/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/da_DK/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 9a8b74c75f69471e69ec33999929675b8b37f993 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:29 -0700 Subject: [PATCH 0018/4057] New translations permissions.md (German) --- locale/de_DE/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/de_DE/content/codebase/permissions.md diff --git a/locale/de_DE/content/codebase/permissions.md b/locale/de_DE/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/de_DE/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From d2670476b7ab1eb176cbb0b4929b8913481ea812 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:30 -0700 Subject: [PATCH 0019/4057] New translations permissions.md (Greek) --- locale/el_GR/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/el_GR/content/codebase/permissions.md diff --git a/locale/el_GR/content/codebase/permissions.md b/locale/el_GR/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/el_GR/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 4b566fff0ccc0046951bf2ef820ee38185b8fb89 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:30 -0700 Subject: [PATCH 0020/4057] New translations permissions.md (Basque) --- locale/eu_ES/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/eu_ES/content/codebase/permissions.md diff --git a/locale/eu_ES/content/codebase/permissions.md b/locale/eu_ES/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/eu_ES/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From e08a54e0969b6850bd2632a0a89c092f06b66ee3 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:31 -0700 Subject: [PATCH 0021/4057] New translations permissions.md (Finnish) --- locale/fi_FI/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/fi_FI/content/codebase/permissions.md diff --git a/locale/fi_FI/content/codebase/permissions.md b/locale/fi_FI/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/fi_FI/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From a5116d3b584453e6dfa310190aab81c3183cfb5a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:32 -0700 Subject: [PATCH 0022/4057] New translations permissions.md (Hebrew) --- locale/he_IL/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/he_IL/content/codebase/permissions.md diff --git a/locale/he_IL/content/codebase/permissions.md b/locale/he_IL/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/he_IL/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 109e9ac32872a3db5d80f2fecc31608a985b302d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:33 -0700 Subject: [PATCH 0023/4057] New translations permissions.md (Hungarian) --- locale/hu_HU/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/hu_HU/content/codebase/permissions.md diff --git a/locale/hu_HU/content/codebase/permissions.md b/locale/hu_HU/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/hu_HU/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 44e8004c4001c579d5afe4d17c59e3ecb9cc2c1d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:34 -0700 Subject: [PATCH 0024/4057] New translations activitypub.md (Chinese Simplified) --- .../zh_Hans/content/codebase/activitypub.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/zh_Hans/content/codebase/activitypub.md diff --git a/locale/zh_Hans/content/codebase/activitypub.md b/locale/zh_Hans/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/zh_Hans/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 63f98ea1a329390d057909bf5fd7c5297f2d1ebe Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:35 -0700 Subject: [PATCH 0025/4057] New translations activitypub.md (Turkish) --- locale/tr_TR/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/tr_TR/content/codebase/activitypub.md diff --git a/locale/tr_TR/content/codebase/activitypub.md b/locale/tr_TR/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/tr_TR/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From cec2000af365f8ab624577bca439a48966d840a2 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:36 -0700 Subject: [PATCH 0026/4057] New translations activitypub.md (French) --- locale/fr_FR/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/fr_FR/content/codebase/activitypub.md diff --git a/locale/fr_FR/content/codebase/activitypub.md b/locale/fr_FR/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/fr_FR/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From b770e338b1a6623c8e94c94d1cf9a8ab05f5e843 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:37 -0700 Subject: [PATCH 0027/4057] New translations activitypub.md (Hebrew) --- locale/he_IL/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/he_IL/content/codebase/activitypub.md diff --git a/locale/he_IL/content/codebase/activitypub.md b/locale/he_IL/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/he_IL/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 57f6f8645d72cfad038b575cb8ba7ceea5dda327 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:38 -0700 Subject: [PATCH 0028/4057] New translations activitypub.md (Spanish) --- locale/es_ES/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/es_ES/content/codebase/activitypub.md diff --git a/locale/es_ES/content/codebase/activitypub.md b/locale/es_ES/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/es_ES/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 0628fb4dc49eddb05e7b7340acfbbdd4a090ce21 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:38 -0700 Subject: [PATCH 0029/4057] New translations activitypub.md (Afrikaans) --- locale/af_ZA/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/af_ZA/content/codebase/activitypub.md diff --git a/locale/af_ZA/content/codebase/activitypub.md b/locale/af_ZA/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/af_ZA/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From fbd7861a17e8243b383aad385ff8ee29776732e1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:39 -0700 Subject: [PATCH 0030/4057] New translations activitypub.md (Arabic) --- locale/ar_SA/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ar_SA/content/codebase/activitypub.md diff --git a/locale/ar_SA/content/codebase/activitypub.md b/locale/ar_SA/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ar_SA/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 46d6796362fd6859d407dc62988e9a42f9589892 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:40 -0700 Subject: [PATCH 0031/4057] New translations activitypub.md (Catalan) --- locale/ca_ES/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ca_ES/content/codebase/activitypub.md diff --git a/locale/ca_ES/content/codebase/activitypub.md b/locale/ca_ES/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ca_ES/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 1c846a7c2bc50807629d6720498b283acbffdeb8 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:41 -0700 Subject: [PATCH 0032/4057] New translations activitypub.md (Czech) --- locale/cs_CZ/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/cs_CZ/content/codebase/activitypub.md diff --git a/locale/cs_CZ/content/codebase/activitypub.md b/locale/cs_CZ/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/cs_CZ/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 9a1a65357bb6da4a3448c15291fa45901f542ddc Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:42 -0700 Subject: [PATCH 0033/4057] New translations activitypub.md (Danish) --- locale/da_DK/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/da_DK/content/codebase/activitypub.md diff --git a/locale/da_DK/content/codebase/activitypub.md b/locale/da_DK/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/da_DK/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From d0ee24f703e5064abc043b53f44b45ca343691fe Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:43 -0700 Subject: [PATCH 0034/4057] New translations activitypub.md (German) --- locale/de_DE/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/de_DE/content/codebase/activitypub.md diff --git a/locale/de_DE/content/codebase/activitypub.md b/locale/de_DE/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/de_DE/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 14184fb2e9f3a6ffb94114e325379ea307f6b0ce Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:44 -0700 Subject: [PATCH 0035/4057] New translations activitypub.md (Greek) --- locale/el_GR/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/el_GR/content/codebase/activitypub.md diff --git a/locale/el_GR/content/codebase/activitypub.md b/locale/el_GR/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/el_GR/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 62572092d2df14045967a59cbf90e8c223794a99 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:45 -0700 Subject: [PATCH 0036/4057] New translations activitypub.md (Basque) --- locale/eu_ES/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/eu_ES/content/codebase/activitypub.md diff --git a/locale/eu_ES/content/codebase/activitypub.md b/locale/eu_ES/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/eu_ES/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 5273a249d58f1e04de4f6083d86e9b95cdf17cb0 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:46 -0700 Subject: [PATCH 0037/4057] New translations activitypub.md (Finnish) --- locale/fi_FI/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/fi_FI/content/codebase/activitypub.md diff --git a/locale/fi_FI/content/codebase/activitypub.md b/locale/fi_FI/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/fi_FI/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From c267ed78ac1e3386ee3b14c28924fd93b3f5f474 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:47 -0700 Subject: [PATCH 0038/4057] New translations activitypub.md (Hungarian) --- locale/hu_HU/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/hu_HU/content/codebase/activitypub.md diff --git a/locale/hu_HU/content/codebase/activitypub.md b/locale/hu_HU/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/hu_HU/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 79fdcf0e94179f17ca1da60d2f09bf3982f3bfc7 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:47 -0700 Subject: [PATCH 0039/4057] New translations activitypub.md (Swedish) --- locale/sv_SE/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/sv_SE/content/codebase/activitypub.md diff --git a/locale/sv_SE/content/codebase/activitypub.md b/locale/sv_SE/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/sv_SE/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 079d1d1c65d795dc6736eb9073bf8bacc8b977a3 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:48 -0700 Subject: [PATCH 0040/4057] New translations activitypub.md (Italian) --- locale/it_IT/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/it_IT/content/codebase/activitypub.md diff --git a/locale/it_IT/content/codebase/activitypub.md b/locale/it_IT/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/it_IT/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 3f66039a3a8d6e4d18a96f1d36e9f810b88903d4 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:49 -0700 Subject: [PATCH 0041/4057] New translations activitypub.md (Japanese) --- locale/ja_JP/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ja_JP/content/codebase/activitypub.md diff --git a/locale/ja_JP/content/codebase/activitypub.md b/locale/ja_JP/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ja_JP/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 87382b71c753f916c94e92acb9d5f39b4ac4ba94 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:50 -0700 Subject: [PATCH 0042/4057] New translations activitypub.md (Korean) --- locale/ko_KR/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ko_KR/content/codebase/activitypub.md diff --git a/locale/ko_KR/content/codebase/activitypub.md b/locale/ko_KR/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ko_KR/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 5fee1c8e414e6043e6cb65e1fd4dfeb4fd58ac5a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:51 -0700 Subject: [PATCH 0043/4057] New translations activitypub.md (Lithuanian) --- locale/lt_LT/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/lt_LT/content/codebase/activitypub.md diff --git a/locale/lt_LT/content/codebase/activitypub.md b/locale/lt_LT/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/lt_LT/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From a22d23676027becb6bf15795eadb96f0eab20e13 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:52 -0700 Subject: [PATCH 0044/4057] New translations activitypub.md (Dutch) --- locale/nl_NL/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/nl_NL/content/codebase/activitypub.md diff --git a/locale/nl_NL/content/codebase/activitypub.md b/locale/nl_NL/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/nl_NL/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From c75c9487bd006c80c82182d883bcb573b1ee829a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:53 -0700 Subject: [PATCH 0045/4057] New translations activitypub.md (Norwegian) --- locale/no_NO/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/no_NO/content/codebase/activitypub.md diff --git a/locale/no_NO/content/codebase/activitypub.md b/locale/no_NO/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/no_NO/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From fa67c496e8623b752f51a80624be462449fc1d72 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:54 -0700 Subject: [PATCH 0046/4057] New translations activitypub.md (Polish) --- locale/pl_PL/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/pl_PL/content/codebase/activitypub.md diff --git a/locale/pl_PL/content/codebase/activitypub.md b/locale/pl_PL/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/pl_PL/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 049d847d8e350e572d99698bebece6911d76e8ae Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:55 -0700 Subject: [PATCH 0047/4057] New translations activitypub.md (Portuguese) --- locale/pt_PT/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/pt_PT/content/codebase/activitypub.md diff --git a/locale/pt_PT/content/codebase/activitypub.md b/locale/pt_PT/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/pt_PT/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From b7d1da1708df5034eba20266a140b5394e2d255f Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:56 -0700 Subject: [PATCH 0048/4057] New translations activitypub.md (Russian) --- locale/ru_RU/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/ru_RU/content/codebase/activitypub.md diff --git a/locale/ru_RU/content/codebase/activitypub.md b/locale/ru_RU/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/ru_RU/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From c0f30495588635e9f48079eeba02dfae34add70b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:57 -0700 Subject: [PATCH 0049/4057] New translations activitypub.md (Serbian (Cyrillic)) --- locale/sr_SP/content/codebase/activitypub.md | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 locale/sr_SP/content/codebase/activitypub.md diff --git a/locale/sr_SP/content/codebase/activitypub.md b/locale/sr_SP/content/codebase/activitypub.md new file mode 100644 index 00000000..ac8c034e --- /dev/null +++ b/locale/sr_SP/content/codebase/activitypub.md @@ -0,0 +1,58 @@ +Title: ActivityPub Date: 2021-04-20 Order: 1 + +BookWyrm uses the [ActivityPub](http://activitypub.rocks/) protocol to send and receive user activity between other BookWyrm instances and other services that implement ActivityPub, like [Mastodon](https://joinmastodon.org/). To handle book data, BookWyrm has a handful of extended Activity types which are not part of the standard, but are legible to other BookWyrm instances. + +## Activities and Objects + +### Users and relationships +User relationship interactions follow the standard ActivityPub spec. + +- `Follow`: request to receive statuses from a user, and view their statuses that have followers-only privacy +- `Accept`: approves a `Follow` and finalizes the relationship +- `Reject`: denies a `Follow` +- `Block`: prevent users from seeing one another's statuses, and prevents the blocked user from viewing the actor's profile +- `Update`: updates a user's profile and settings +- `Delete`: deactivates a user +- `Undo`: reverses a `Follow` or `Block` + +### Statuses +#### Object types + +- `Note`: On services like Mastodon, `Note`s are the primary type of status. They contain a message body, attachments, can mention users, and be replies to statuses of any type. Within BookWyrm, `Note`s can only be created as direct messages or as replies to other statuses. +- `Review`: A review is a status in repsonse to a book (indicated by the `inReplyToBook` field), which has a title, body, and numerical rating between 0 (not rated) and 5. +- `Comment`: A comment on a book mentions a book and has a message body. +- `Quotation`: A quote has a message body, an excerpt from a book, and mentions a book + + +#### Activities + +- `Create`: saves a new status in the database. + + **Note**: BookWyrm only accepts `Create` activities if they are: + + - Direct messages (i.e., `Note`s with the privacy level `direct`, which mention a local user), + - Related to a book (of a custom status type that includes the field `inReplyToBook`), + - Replies to existing statuses saved in the database +- `Delete`: Removes a status +- `Like`: Creates a favorite on the status +- `Announce`: Boosts the status into the actor's timeline +- `Undo`: Reverses a `Like` or `Announce` + +### Collections +User's books and lists are represented by [`OrderedCollection`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) + +#### Objects + +- `Shelf`: A user's book collection. By default, every user has a `to-read`, `reading`, and `read` shelf which are used to track reading progress. +- `List`: A collection of books that may have items contributed by users other than the one who created the list. + +#### Activities + +- `Create`: Adds a shelf or list to the database. +- `Delete`: Removes a shelf or list. +- `Add`: Adds a book to a shelf or list. +- `Remove`: Removes a book from a shelf or list. + + +## Alternative Serialization +Because BookWyrm uses custom object types (`Review`, `Comment`, `Quotation`) that aren't supported by ActivityPub, statuses are transformed into standard types when sent to or viewed by non-BookWyrm services. `Review`s are converted into `Article`s, and `Comment`s and `Quotation`s are converted into `Note`s, with a link to the book and the cover image attached. From 39b382bcad8684d09b9d3c2304fba947f6da3e90 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:58 -0700 Subject: [PATCH 0050/4057] New translations permissions.md (Italian) --- locale/it_IT/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/it_IT/content/codebase/permissions.md diff --git a/locale/it_IT/content/codebase/permissions.md b/locale/it_IT/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/it_IT/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From b16916398f6805148cc9e5bb8689cec10e9bdc6e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:55:59 -0700 Subject: [PATCH 0051/4057] New translations permissions.md (Japanese) --- locale/ja_JP/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ja_JP/content/codebase/permissions.md diff --git a/locale/ja_JP/content/codebase/permissions.md b/locale/ja_JP/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ja_JP/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 7eb41b257b1a79def73e9612d6b0279dbd7a7c3e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:00 -0700 Subject: [PATCH 0052/4057] New translations contributing.md (Lithuanian) --- .../lt_LT/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/lt_LT/content/contributing/contributing.md diff --git a/locale/lt_LT/content/contributing/contributing.md b/locale/lt_LT/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/lt_LT/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 10a52c345513cea329e800bb1c03e4d17b21443a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:01 -0700 Subject: [PATCH 0053/4057] New translations contributing.md (German) --- .../de_DE/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/de_DE/content/contributing/contributing.md diff --git a/locale/de_DE/content/contributing/contributing.md b/locale/de_DE/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/de_DE/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From e55a1d499e8d87c60ecd9bdaffab72a54ec11ec6 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:02 -0700 Subject: [PATCH 0054/4057] New translations contributing.md (Greek) --- .../el_GR/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/el_GR/content/contributing/contributing.md diff --git a/locale/el_GR/content/contributing/contributing.md b/locale/el_GR/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/el_GR/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From d9130ff849c4ec94074aa2c5a01adbe480518a6e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:03 -0700 Subject: [PATCH 0055/4057] New translations contributing.md (Basque) --- .../eu_ES/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/eu_ES/content/contributing/contributing.md diff --git a/locale/eu_ES/content/contributing/contributing.md b/locale/eu_ES/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/eu_ES/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 074454d6966184af9df8dca05484d351d8701b18 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:03 -0700 Subject: [PATCH 0056/4057] New translations contributing.md (Finnish) --- .../fi_FI/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/fi_FI/content/contributing/contributing.md diff --git a/locale/fi_FI/content/contributing/contributing.md b/locale/fi_FI/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/fi_FI/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 07385f5ab4c9141952d8c0918208c3db96a4c51b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:04 -0700 Subject: [PATCH 0057/4057] New translations contributing.md (Hebrew) --- .../he_IL/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/he_IL/content/contributing/contributing.md diff --git a/locale/he_IL/content/contributing/contributing.md b/locale/he_IL/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/he_IL/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 03d600f883400867cf5d2515bb20e38ba323c1da Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:05 -0700 Subject: [PATCH 0058/4057] New translations contributing.md (Hungarian) --- .../hu_HU/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/hu_HU/content/contributing/contributing.md diff --git a/locale/hu_HU/content/contributing/contributing.md b/locale/hu_HU/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/hu_HU/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From d4717c87e63989fa4ec2ba82d0dff60e1cb4425d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:06 -0700 Subject: [PATCH 0059/4057] New translations contributing.md (Italian) --- .../it_IT/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/it_IT/content/contributing/contributing.md diff --git a/locale/it_IT/content/contributing/contributing.md b/locale/it_IT/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/it_IT/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 5081b1cbc22cab1fe967d8674e64cca994467617 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:07 -0700 Subject: [PATCH 0060/4057] New translations contributing.md (Japanese) --- .../ja_JP/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ja_JP/content/contributing/contributing.md diff --git a/locale/ja_JP/content/contributing/contributing.md b/locale/ja_JP/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ja_JP/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From ed960f9a0f47234afbe1202133a1b5358a25a543 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:08 -0700 Subject: [PATCH 0061/4057] New translations contributing.md (Korean) --- .../ko_KR/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ko_KR/content/contributing/contributing.md diff --git a/locale/ko_KR/content/contributing/contributing.md b/locale/ko_KR/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ko_KR/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From dfac031cdae52d12fa4c8a68b9ef862e962995e7 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:09 -0700 Subject: [PATCH 0062/4057] New translations contributing.md (Dutch) --- .../nl_NL/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/nl_NL/content/contributing/contributing.md diff --git a/locale/nl_NL/content/contributing/contributing.md b/locale/nl_NL/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/nl_NL/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 16457befe28b380713168ddf2ffc1a1e5a8b96b5 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:09 -0700 Subject: [PATCH 0063/4057] New translations contributing.md (Czech) --- .../cs_CZ/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/cs_CZ/content/contributing/contributing.md diff --git a/locale/cs_CZ/content/contributing/contributing.md b/locale/cs_CZ/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/cs_CZ/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 5e2a3c6a1eba714cc92a152558e0461ab0d3077f Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:10 -0700 Subject: [PATCH 0064/4057] New translations contributing.md (Norwegian) --- .../no_NO/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/no_NO/content/contributing/contributing.md diff --git a/locale/no_NO/content/contributing/contributing.md b/locale/no_NO/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/no_NO/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From ced093a16073bdd1b4e3ca949b94655b844700c2 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:11 -0700 Subject: [PATCH 0065/4057] New translations contributing.md (Polish) --- .../pl_PL/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/pl_PL/content/contributing/contributing.md diff --git a/locale/pl_PL/content/contributing/contributing.md b/locale/pl_PL/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/pl_PL/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 1640022622af84875d66f346dde7274033959246 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:12 -0700 Subject: [PATCH 0066/4057] New translations contributing.md (Portuguese) --- .../pt_PT/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/pt_PT/content/contributing/contributing.md diff --git a/locale/pt_PT/content/contributing/contributing.md b/locale/pt_PT/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/pt_PT/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 6cb58cca47c77573a5d7603dfe767c228b515016 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:13 -0700 Subject: [PATCH 0067/4057] New translations contributing.md (Russian) --- .../ru_RU/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ru_RU/content/contributing/contributing.md diff --git a/locale/ru_RU/content/contributing/contributing.md b/locale/ru_RU/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ru_RU/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From bae75a58d9714df76920485d02e2982f9a29189b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:14 -0700 Subject: [PATCH 0068/4057] New translations contributing.md (Serbian (Cyrillic)) --- .../sr_SP/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/sr_SP/content/contributing/contributing.md diff --git a/locale/sr_SP/content/contributing/contributing.md b/locale/sr_SP/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/sr_SP/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From c1f0cd82868f0841cb9aac62f05f837c013fc12e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:15 -0700 Subject: [PATCH 0069/4057] New translations contributing.md (Swedish) --- .../sv_SE/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/sv_SE/content/contributing/contributing.md diff --git a/locale/sv_SE/content/contributing/contributing.md b/locale/sv_SE/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/sv_SE/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 7642eecb0f162f96714147c21030faa65ae01ab3 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:16 -0700 Subject: [PATCH 0070/4057] New translations contributing.md (Turkish) --- .../tr_TR/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/tr_TR/content/contributing/contributing.md diff --git a/locale/tr_TR/content/contributing/contributing.md b/locale/tr_TR/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/tr_TR/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 9694cad8e909d255661cbdd7c6af5af4ad13f51c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:16 -0700 Subject: [PATCH 0071/4057] New translations contributing.md (Ukrainian) --- .../uk_UA/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/uk_UA/content/contributing/contributing.md diff --git a/locale/uk_UA/content/contributing/contributing.md b/locale/uk_UA/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/uk_UA/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 2231dd587e6883b7ecc05f681e1c4c82a1b022f8 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:17 -0700 Subject: [PATCH 0072/4057] New translations contributing.md (Chinese Simplified) --- .../content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/zh_Hans/content/contributing/contributing.md diff --git a/locale/zh_Hans/content/contributing/contributing.md b/locale/zh_Hans/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/zh_Hans/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From c30a1e747015f8c1d556bc953547d509856af08c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:18 -0700 Subject: [PATCH 0073/4057] New translations contributing.md (Chinese Traditional) --- .../content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/zh_Hant/content/contributing/contributing.md diff --git a/locale/zh_Hant/content/contributing/contributing.md b/locale/zh_Hant/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/zh_Hant/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 5838aa5e5550edf576669ff1947096779a90d2b1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:19 -0700 Subject: [PATCH 0074/4057] New translations contributing.md (Danish) --- .../da_DK/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/da_DK/content/contributing/contributing.md diff --git a/locale/da_DK/content/contributing/contributing.md b/locale/da_DK/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/da_DK/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From b6919a2c9b5574964d0598c74f7a64371d50e34b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:20 -0700 Subject: [PATCH 0075/4057] New translations contributing.md (Catalan) --- .../ca_ES/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ca_ES/content/contributing/contributing.md diff --git a/locale/ca_ES/content/contributing/contributing.md b/locale/ca_ES/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ca_ES/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 0934ffdf9f63af8aff6d292e70cb85cfdbd66df6 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:21 -0700 Subject: [PATCH 0076/4057] New translations permissions.md (Korean) --- locale/ko_KR/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ko_KR/content/codebase/permissions.md diff --git a/locale/ko_KR/content/codebase/permissions.md b/locale/ko_KR/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ko_KR/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 91841ffd781fa023a287af77370b2fbba7187b75 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:22 -0700 Subject: [PATCH 0077/4057] New translations permissions.md (Chinese Simplified) --- .../zh_Hans/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/zh_Hans/content/codebase/permissions.md diff --git a/locale/zh_Hans/content/codebase/permissions.md b/locale/zh_Hans/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/zh_Hans/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 7ea9b882d398c7a396dab42d601b13dc1beceaef Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:23 -0700 Subject: [PATCH 0078/4057] New translations permissions.md (Lithuanian) --- locale/lt_LT/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/lt_LT/content/codebase/permissions.md diff --git a/locale/lt_LT/content/codebase/permissions.md b/locale/lt_LT/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/lt_LT/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 0f8adca0b05a1db11331b6c63e0c56c30d0c5e21 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:23 -0700 Subject: [PATCH 0079/4057] New translations permissions.md (Dutch) --- locale/nl_NL/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/nl_NL/content/codebase/permissions.md diff --git a/locale/nl_NL/content/codebase/permissions.md b/locale/nl_NL/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/nl_NL/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 1353954412e9e63bf8c0b46f6ce8b1609d2401a5 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:24 -0700 Subject: [PATCH 0080/4057] New translations permissions.md (Norwegian) --- locale/no_NO/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/no_NO/content/codebase/permissions.md diff --git a/locale/no_NO/content/codebase/permissions.md b/locale/no_NO/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/no_NO/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From ca98cc87f62c43d79cb733bc2b29cd544d85025d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:25 -0700 Subject: [PATCH 0081/4057] New translations permissions.md (Polish) --- locale/pl_PL/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/pl_PL/content/codebase/permissions.md diff --git a/locale/pl_PL/content/codebase/permissions.md b/locale/pl_PL/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/pl_PL/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 9949f3c06e1cb51362400edd9f15527159a15a31 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:26 -0700 Subject: [PATCH 0082/4057] New translations permissions.md (Portuguese) --- locale/pt_PT/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/pt_PT/content/codebase/permissions.md diff --git a/locale/pt_PT/content/codebase/permissions.md b/locale/pt_PT/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/pt_PT/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 36b8a5e3b1cd7b2add95c9e39c110239853c0173 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:27 -0700 Subject: [PATCH 0083/4057] New translations permissions.md (Russian) --- locale/ru_RU/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/ru_RU/content/codebase/permissions.md diff --git a/locale/ru_RU/content/codebase/permissions.md b/locale/ru_RU/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/ru_RU/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 1c48d1e9c415e93e35aa33dec9e9c18adb0b407e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:28 -0700 Subject: [PATCH 0084/4057] New translations permissions.md (Serbian (Cyrillic)) --- locale/sr_SP/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/sr_SP/content/codebase/permissions.md diff --git a/locale/sr_SP/content/codebase/permissions.md b/locale/sr_SP/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/sr_SP/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From e8ed17d2977ca4e76e9b75dd26b9516ed09806a0 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:28 -0700 Subject: [PATCH 0085/4057] New translations permissions.md (Swedish) --- locale/sv_SE/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/sv_SE/content/codebase/permissions.md diff --git a/locale/sv_SE/content/codebase/permissions.md b/locale/sv_SE/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/sv_SE/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From aafd04d45c120cf361c4fe9799f5e04c7c41f13a Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:29 -0700 Subject: [PATCH 0086/4057] New translations permissions.md (Turkish) --- locale/tr_TR/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/tr_TR/content/codebase/permissions.md diff --git a/locale/tr_TR/content/codebase/permissions.md b/locale/tr_TR/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/tr_TR/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 0b6dab9ba11abe7ce45d6de0c0708d068fb01017 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:30 -0700 Subject: [PATCH 0087/4057] New translations permissions.md (Ukrainian) --- locale/uk_UA/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/uk_UA/content/codebase/permissions.md diff --git a/locale/uk_UA/content/codebase/permissions.md b/locale/uk_UA/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/uk_UA/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From f59b6ecc0e3069b2007dc1b41266c5bef574d3e6 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:31 -0700 Subject: [PATCH 0088/4057] New translations permissions.md (Chinese Traditional) --- .../zh_Hant/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/zh_Hant/content/codebase/permissions.md diff --git a/locale/zh_Hant/content/codebase/permissions.md b/locale/zh_Hant/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/zh_Hant/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 1dc545f440e7f46c8f12749b0ba8de195128cf1b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:32 -0700 Subject: [PATCH 0089/4057] New translations contributing.md (Arabic) --- .../ar_SA/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ar_SA/content/contributing/contributing.md diff --git a/locale/ar_SA/content/contributing/contributing.md b/locale/ar_SA/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ar_SA/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 410d1f4db59e227146cc85bbaf7ede372cad902c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:33 -0700 Subject: [PATCH 0090/4057] New translations permissions.md (Vietnamese) --- locale/vi_VN/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/vi_VN/content/codebase/permissions.md diff --git a/locale/vi_VN/content/codebase/permissions.md b/locale/vi_VN/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/vi_VN/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From d6f269f963ca28bdbc7d7985af86626dab4d8ddc Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:34 -0700 Subject: [PATCH 0091/4057] New translations permissions.md (Galician) --- locale/gl_ES/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/gl_ES/content/codebase/permissions.md diff --git a/locale/gl_ES/content/codebase/permissions.md b/locale/gl_ES/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/gl_ES/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 368d66312cf5892c546342e26be7c5a94369fa5e Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:35 -0700 Subject: [PATCH 0092/4057] New translations permissions.md (Portuguese, Brazilian) --- locale/pt_BR/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/pt_BR/content/codebase/permissions.md diff --git a/locale/pt_BR/content/codebase/permissions.md b/locale/pt_BR/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/pt_BR/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 1d0839680f6588f3cd8b16741f47a12c4d33943c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:36 -0700 Subject: [PATCH 0093/4057] New translations permissions.md (Welsh) --- locale/cy_GB/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/cy_GB/content/codebase/permissions.md diff --git a/locale/cy_GB/content/codebase/permissions.md b/locale/cy_GB/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/cy_GB/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 66cd56f82d687cdc9e1697f827ef4300e5880d3f Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:36 -0700 Subject: [PATCH 0094/4057] New translations permissions.md (Oulipo) --- .../en_Oulipo/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/en_Oulipo/content/codebase/permissions.md diff --git a/locale/en_Oulipo/content/codebase/permissions.md b/locale/en_Oulipo/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/en_Oulipo/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 09c0ae5b6f262f8c78bc306baa89bf9f91bbc95d Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:37 -0700 Subject: [PATCH 0095/4057] New translations permissions.md (Eastern Min) --- locale/cdo/content/codebase/permissions.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 locale/cdo/content/codebase/permissions.md diff --git a/locale/cdo/content/codebase/permissions.md b/locale/cdo/content/codebase/permissions.md new file mode 100644 index 00000000..c94f92a1 --- /dev/null +++ b/locale/cdo/content/codebase/permissions.md @@ -0,0 +1,19 @@ +Title: Permissions Date: 2021-04-18 Order: 2 + +User access to different features is controlled using Django's [built-in authentication system](https://docs.djangoproject.com/en/3.2/topics/auth/default/). When an instance is created, the `initdb` script creates a set of permissions, which are assinged to groups. By default, all new users are assigned the `editor` group, which allows them to edit book metadata. + +The instance administrator should have `superuser` status, which gives them access to Django admin (`/admin`) and confers all permissions to that user. + +## Permissions and groups +This table shows the four groups (admin, moderator, editor, and user) and what permissions users in that group have: + +| | admin | moderator | editor | user | +| ---------------------- | ----- | --------- | ------ | ---- | +| edit instance settings | ✔️ | - | - | - | +| change user level | ✔️ | - | - | - | +| manage federation | ✔️ | ✔️ | - | - | +| issue invites | ✔️ | ✔️ | - | - | +| deactivate users | ✔️ | ✔️ | - | - | +| delete posts | ✔️ | ✔️ | - | - | +| edit books | ✔️ | ✔️ | ✔️ | - | +| upload covers | ✔️ | ✔️ | ✔️ | ✔️ | From 46d009a50e449507442011f6e5706ba5dd227aa4 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:38 -0700 Subject: [PATCH 0096/4057] New translations contributing.md (Romanian) --- .../ro_RO/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/ro_RO/content/contributing/contributing.md diff --git a/locale/ro_RO/content/contributing/contributing.md b/locale/ro_RO/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/ro_RO/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 21c4a7ab37af687af661591d48a9f8950d2543a5 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:39 -0700 Subject: [PATCH 0097/4057] New translations contributing.md (French) --- .../fr_FR/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/fr_FR/content/contributing/contributing.md diff --git a/locale/fr_FR/content/contributing/contributing.md b/locale/fr_FR/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/fr_FR/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 74f93415a874025745bda385ea5313c3279e54ed Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:40 -0700 Subject: [PATCH 0098/4057] New translations contributing.md (Spanish) --- .../es_ES/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/es_ES/content/contributing/contributing.md diff --git a/locale/es_ES/content/contributing/contributing.md b/locale/es_ES/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/es_ES/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From d65bbfd183131ec5e85cb74d6574e25b158acde1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:41 -0700 Subject: [PATCH 0099/4057] New translations contributing.md (Afrikaans) --- .../af_ZA/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/af_ZA/content/contributing/contributing.md diff --git a/locale/af_ZA/content/contributing/contributing.md b/locale/af_ZA/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/af_ZA/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From 0bfa1c1e795f6143d05a83b4c57fb2de5e663e3b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:42 -0700 Subject: [PATCH 0100/4057] New translations contributing.md (Vietnamese) --- .../vi_VN/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/vi_VN/content/contributing/contributing.md diff --git a/locale/vi_VN/content/contributing/contributing.md b/locale/vi_VN/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/vi_VN/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From efc7cd493eb54cdfc84f87431779b67b543a2b82 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:42 -0700 Subject: [PATCH 0101/4057] New translations contributing.md (Galician) --- .../gl_ES/content/contributing/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 locale/gl_ES/content/contributing/contributing.md diff --git a/locale/gl_ES/content/contributing/contributing.md b/locale/gl_ES/content/contributing/contributing.md new file mode 100644 index 00000000..9630a15e --- /dev/null +++ b/locale/gl_ES/content/contributing/contributing.md @@ -0,0 +1,17 @@ +Title: How to Contribute Date: 2021-04-12 Order: 1 + +There are many ways you can contribute to this project, regardless of your level of technical expertise. + +## Feedback and feature requests +Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/bookwyrm-social/bookwyrm/issues). + +## Code contributions +Code contributions are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/bookwyrm-social/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out. + +If you have questions about the project or contributing, you can join the [BookWyrm matrix chat](https://app.element.io/#/room/#bookwyrm:matrix.org). + +## Translation +Do you speak a language besides English? BookWyrm needs localization! You can add and edit translations at [translate.joinbookwyrm.com](http://translate.joinbookwyrm.com/) + +## Financial Support +BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can become a sustaining contributor via [Patreon](https://www.patreon.com/bookwyrm) or [OpenCollective](https://opencollective.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo). From b14582d7bc71efcbc166db46127f435594b707a2 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:43 -0700 Subject: [PATCH 0102/4057] New translations install-dev.md (Welsh) --- .../cy_GB/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/cy_GB/content/contributing/install-dev.md diff --git a/locale/cy_GB/content/contributing/install-dev.md b/locale/cy_GB/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/cy_GB/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From 8b8097a06ff9ae2968e8ede2255143d140f12520 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:44 -0700 Subject: [PATCH 0103/4057] New translations install-dev.md (Serbian (Cyrillic)) --- .../sr_SP/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/sr_SP/content/contributing/install-dev.md diff --git a/locale/sr_SP/content/contributing/install-dev.md b/locale/sr_SP/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/sr_SP/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From d6ef2f7ae429414d16a3a065694ccdabcaebe6ec Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:45 -0700 Subject: [PATCH 0104/4057] New translations install-dev.md (Swedish) --- .../sv_SE/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/sv_SE/content/contributing/install-dev.md diff --git a/locale/sv_SE/content/contributing/install-dev.md b/locale/sv_SE/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/sv_SE/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From a7ddd8fa3a0c80ad88ca2fe3063999631f1ba1be Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:46 -0700 Subject: [PATCH 0105/4057] New translations install-dev.md (Turkish) --- .../tr_TR/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/tr_TR/content/contributing/install-dev.md diff --git a/locale/tr_TR/content/contributing/install-dev.md b/locale/tr_TR/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/tr_TR/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From 129ed49bbc0b849f53a54ba1523b0ff500757e33 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:47 -0700 Subject: [PATCH 0106/4057] New translations install-dev.md (Ukrainian) --- .../uk_UA/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/uk_UA/content/contributing/install-dev.md diff --git a/locale/uk_UA/content/contributing/install-dev.md b/locale/uk_UA/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/uk_UA/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From c1bf994f8a51fd5e8b6fc72c0c6669df3720a24b Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:48 -0700 Subject: [PATCH 0107/4057] New translations install-dev.md (Chinese Simplified) --- .../content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/zh_Hans/content/contributing/install-dev.md diff --git a/locale/zh_Hans/content/contributing/install-dev.md b/locale/zh_Hans/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/zh_Hans/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From c77ad2686e157cdaecb7ab9ed3c30250074db896 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:49 -0700 Subject: [PATCH 0108/4057] New translations install-dev.md (Chinese Traditional) --- .../content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/zh_Hant/content/contributing/install-dev.md diff --git a/locale/zh_Hant/content/contributing/install-dev.md b/locale/zh_Hant/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/zh_Hant/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From e2d93d0816df4a6816d1756f6cdb28510fbc72e8 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:49 -0700 Subject: [PATCH 0109/4057] New translations install-dev.md (Vietnamese) --- .../vi_VN/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/vi_VN/content/contributing/install-dev.md diff --git a/locale/vi_VN/content/contributing/install-dev.md b/locale/vi_VN/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/vi_VN/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From 7b7b2a7c8f9729ee8c1c58b82f284eb01aad91e1 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:50 -0700 Subject: [PATCH 0110/4057] New translations install-dev.md (Galician) --- .../gl_ES/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/gl_ES/content/contributing/install-dev.md diff --git a/locale/gl_ES/content/contributing/install-dev.md b/locale/gl_ES/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/gl_ES/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From 97fda7c11f32fbfbdfb8a2e5b70beb5c1dd69de3 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:51 -0700 Subject: [PATCH 0111/4057] New translations install-dev.md (Portuguese, Brazilian) --- .../pt_BR/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/pt_BR/content/contributing/install-dev.md diff --git a/locale/pt_BR/content/contributing/install-dev.md b/locale/pt_BR/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/pt_BR/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From c77ab3291042a425ec6c32c251d2ace862696cb9 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:52 -0700 Subject: [PATCH 0112/4057] New translations install-dev.md (Oulipo) --- .../content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/en_Oulipo/content/contributing/install-dev.md diff --git a/locale/en_Oulipo/content/contributing/install-dev.md b/locale/en_Oulipo/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/en_Oulipo/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From d6ebd25c589f7b510f89bd4dfc404c45c6a78568 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:53 -0700 Subject: [PATCH 0113/4057] New translations install-dev.md (Portuguese) --- .../pt_PT/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/pt_PT/content/contributing/install-dev.md diff --git a/locale/pt_PT/content/contributing/install-dev.md b/locale/pt_PT/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/pt_PT/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From bedd3f542546c401d04513316187d388787e708c Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:54 -0700 Subject: [PATCH 0114/4057] New translations install-dev.md (Eastern Min) --- .../cdo/content/contributing/install-dev.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 locale/cdo/content/contributing/install-dev.md diff --git a/locale/cdo/content/contributing/install-dev.md b/locale/cdo/content/contributing/install-dev.md new file mode 100644 index 00000000..e8fee9ca --- /dev/null +++ b/locale/cdo/content/contributing/install-dev.md @@ -0,0 +1,53 @@ +Title: Developer Environment Date: 2021-04-12 Order: 2 + +## Prerequisites + +These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started. + +## Setting up the developer environment + +- Get a copy of [the BookWyrm codebase from GitHub](https://github.com/bookwyrm-social/bookwyrm). You can [create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of the repository, and then [use `git clone` to download the code](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your computer. +- Go to the directory which contains the code on your computer, you'll be working from there from here on out. +- Set up your development environment variables file by copying the example environment file (`.env.example`) into a new file named `.env`. In the command line, you can do this with: +``` +:::bash linenums=False +cp .env.example .env +``` +- In `.env`, change `DEBUG` to `true` +- Optionally, you can use a service like [ngrok](https://ngrok.com/) to set up a domain name, and set the `DOMAIN` variable in your `.env` file to the domain name generated by ngrok. + +- Set up nginx for development by copying the developer nginx configuration file (`nginx/development`) into a new file named `nginx/default.conf`: +``` +:::bash linenums=False +cp nginx/development nginx/default.conf +``` + +- Start the application. In the command line, run: +``` +:::shell linenums=False +./bw-dev build # Build the docker images +./bw-dev setup # Initialize the database and run migrations +./bw-dev up # Start the docker containers +``` +- Once the build is complete, you can access the instance at `http://localhost:1333` and create an admin user. + +If you're curious: the `./bw-dev` command is a simple shell script runs various other tools: above, you could skip it and run `docker-compose build` or `docker-compose up` directly if you like. `./bw-dev` just collects them into one common place for convenience. Run it without arguments to get a list of available commands, read the [documentation page](/command-line-tool.html) for it, or open it up and look around to see exactly what each command is doing! + +### Editing or creating Models + +If you change or create a model, you will probably change the database structure. For these changes to have effect you will need to run Django's `makemigrations` command to create a new [Django migrations file](https://docs.djangoproject.com/en/3.2/topics/migrations), and then `migrate` it: + +``` +:::shell linenums=False +./bw-dev makemigrations +./bw-dev migrate +``` + +### Editing static files +Any time you edit the CSS or JavaScript, you will need to run Django's `collectstatic` command again in order for your changes to have effect: +``` +:::shell linenums=False +./bw-dev collectstatic +``` + +If you have [installed yarn](https://yarnpkg.com/getting-started/install), you can run `yarn watch:static` to automatically run the previous script every time a change occurs in `bookwyrm/static` directory. From 89f54120a1a555389ca570ccd6bb5845b3169657 Mon Sep 17 00:00:00 2001 From: Mouse Reeve Date: Sat, 14 May 2022 09:56:55 -0700 Subject: [PATCH 0115/4057] New translations style_guide.md (Romanian) --- .../ro_RO/content/contributing/style_guide.md | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 locale/ro_RO/content/contributing/style_guide.md diff --git a/locale/ro_RO/content/contributing/style_guide.md b/locale/ro_RO/content/contributing/style_guide.md new file mode 100644 index 00000000..2f0dbe13 --- /dev/null +++ b/locale/ro_RO/content/contributing/style_guide.md @@ -0,0 +1,51 @@ +Title: Style Guide Date: 2021-10-20 Order: 4 + +## Pull requests + +So you want to contribute code to BookWyrm: that rules! If there's an open issue that you'd like to fix, it's helpful to comment on the issue so work doesn't get duplicated. Try to keep the scope of pull requests small and focused on a single topic. That way it's easier to review, and if one part needs changes, it won't hold up the other parts. + +If you aren't sure how to fix something, or you aren't able to get around to it, that's totally okay, just leave a comment on the pull request and we'll figure it out 💖. + +Pull requests have to pass all the automated checks before they can be merged - this includes style checks, global linters, a security check, and unit tests. + +## Linting + +### Global + +We use [EditorConfig](https://editorconfig.org) to maintain consistent indenting and line endings. + +### Python + +BookWyrm uses the [Black](https://github.com/psf/black) code formatter to keep the Python codebase consistent styled. All new pull requests are checked with GitHub actions, and you can automatically fix code style problems by running `./bw-dev black` + +Code is also checked with Pylint using GitHub Actions. Pylint warnings must be addressed before pull requests are merged, but it's a judgement call if the suggestion should be used, or the warning suppressed. To suppress a warning, add a comment at the end of or on the line above the warnings: `# pylint: disable=warning-name` + +### Templates (HTML) + +Your pull request will also be checked by the [curlylint](https://www.curlylint.org) linter for Django templates. + +### CSS + +We use [stylelint](https://stylelint.io) to check all CSS rules. As with Pylint [you can disable stylelint](https://stylelint.io/user-guide/ignore-code) for a particular rule, but you will need a good justification for doing so. + +### JavaScript + +[ESLint](https://eslint.org) checks any JavaScript changes you have made. If ESLint doesn't like your working JavaScript, check the linter message for the exact problem. + +## Inclusive Design + +Bookwyrm aims to be as inclusive and accessible as possible. + +When contributing code, check the [Inclusive Web Design Checklist](https://github.com/bookwyrm-social/bookwyrm/discussions/1354) before you file your pull request. For accessibility advice, [A11Y-101](https://www.a11y-101.com/development) is also a useful source. For information on how to make your page templates multi-lingual, see the [Translations section](/translations.html). + +Some particular things that Bookwyrm contributors have found useful to remember are: + +### Forms + +* Only use `input[type="checkbox"]` or `input[type="radio"]` inside `