Commit Graph

580 Commits

Author SHA1 Message Date
Nik Clayton 49868155b9
feat: Document datetime and date formats (#1565)
Add a new document that precisely describes the string representation of
datetime and date types.

The previous description of them as "ISO 8601 Datetime" was very
imprecise, as ISO 8601 describes many different ways of representing a
datetime and date.

Specify the datetime format precisely as the ISO 8601 profile described
in RFC 3339, and the date format precisely as the "Complete date" format
from the W3C note on date and time formats.

Adjust all the references to ISO 8601 datetimes or dates to link back
to the definition.

Fixes #1420
2024-11-27 15:08:51 +00:00
Andy Piper 09dc6a85cd
e-mail -> email in most documentation references. (#1365) 2024-11-22 16:33:04 +00:00
Nik Clayton 9a8c9659b0
fix: Replace "interacted with" with "reblogged" (#1564)
By clear about the situations in which the `update` status type is sent.
2024-11-22 10:08:47 +01:00
Shlee f25f26732b
Docs to match #32908 - REPLICA_DB_TASKS / REPLICA_PREPARED_STATEMENTS (#1561)
* Update scaling.md

* Update scaling.md

* Update scaling.md
2024-11-19 13:25:40 +01:00
Benoit 0b15ac190f
Update postgresql version in path (#1544)
apt.postgresql.org defaults to v17 for Ubuntu 24.04.
2024-10-10 19:06:32 +02:00
David Roetzel 4a0d6cc7ce
Fix typo in oauth api parameters (#1545)
Fix typo.
2024-10-10 18:59:26 +02:00
Emelia Smith cb3aa4de10
Document new OAuth changes for 4.3.0 (#1445)
* Improve deprecation messaging for Application#vapid_key

* Format JSON examples in Instance methods

* Remove vapid_key from Apps API examples, since this property is deprecated on Application entity

* Add documentation for new OAuth 2.0 features added in 4.3.0

* Improve documentation for oauth-scopes

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Add deprecated and removed shortcode labels

* Use deprecated and removed shortcodes

* Improve OAuth documentation

* More OAuth documentation improvements

* Correct streaming API documentation after 4.2.0 changes

* Add note about improved Push Subscription API validation in 4.3.0

* Fix inconsistent OAuth label formatting

* Add note that there is a relationship between Accounts and the Application used to create them

* Add note that application registration endpoint also supports JSON bodies

* Be consistent in the formatting of placeholder values for Bearer tokens

* code review changes

* Slight changes in wording

* Add documentation for PKCE

* Removal of crypto oauth scope

* Cross-link authorization's scope with the OAuth Scopes documentation

* Update content/en/methods/oauth.md

* Update content/en/api/oauth-scopes.md

---------

Co-authored-by: Matt Jankowski <matt@jankowski.online>
Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-10 14:44:19 +02:00
Claire c99799ac3e
Add documentation for `include_filtered` (#1543)
* Add documentation for `include_filtered`

* Update grouped_notifications.md
2024-10-09 16:54:13 +02:00
John Haugabook b0c7cca93b
manrope.scss - include manrope folder in path (#1515)
Add manrope folder to path for font manrope-variable.woff2.
2024-10-09 12:36:10 +01:00
Alyx 4f83524882
Remove instructions for cleanup crons (#1529)
Since the retention policy for cached content and media was added (#19232) a external cron is no longer needed.
2024-10-08 16:08:38 +02:00
David Roetzel 1fc8c2a889
Update installation instructions for 4.3 on Ubuntu 24.04 and Debian 12 (#1537)
* Update installation instructions...

...for Mastodon 4.3 on Ubuntu 24.04 and Debian 12.

* Reorder sections

To get rid of specifying a ruby version. Also simplifies the
steps even further.

* Allow other users to traverse mastodon home

instead of using group permissions. We heard a lot of
different opinions on this and it is clearly not a
solution for everyone, but in contrast to the group
permissions:

* `www-data` will not get write access to mastodon files
* this works identical on Debian and Ubuntu
2024-10-08 14:31:52 +02:00
Michael Stanclift 4d3746f37d
Update all Mastodon product screenshots to 4.3 (#1520)
update all using mastodon screenshots
2024-10-08 11:25:04 +01:00
Claire 42a8dbc20d
Clarify `group_key` for ungrouped notifications (#1539)
* Clarify `group_key` for ungrouped notifications

* Clarify that `grouped_types` affects `group_key` but not streaming API

* Update content/en/methods/grouped_notifications.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-08 11:34:32 +02:00
Claire eadb8b98cc
Add documentation for `likes` and `shares` collections on statuses (#1542) 2024-10-08 11:33:32 +02:00
David Roetzel 958ed69559
Fix typo in redis sentinel env var names (#1540)
Fix typo
2024-10-07 11:31:15 +02:00
Claire 3803173c9e
Remove documentation for `REGEXP_TIMEOUT` environment variable (#1538)
It was only added in the development version, and removed afterwards without reaching any (pre-)release.
2024-09-30 13:47:22 +02:00
Kurt Thams e64502ca23
Remove outdated reference to DigitalOcean 1-click (#1485)
The link to DigitalOcean marketplace leads to nowhere, and there doesn't appear to be a replacement on DigitalOcean's site.
2024-09-25 16:23:19 +02:00
Johannes Ernst 41ee8f3150
Clarify the description of ALLOW_PRIVATE_ADDRESSES (#1533)
Co-authored-by: Johannes Ernst <git@j12t.org>
2024-09-25 15:49:59 +02:00
Renaud Chaput 9d2ff8b31c
Update documentation to add `follow` notifications grouping (#1536)
Related to https://github.com/mastodon/mastodon/pull/32085
2024-09-25 15:49:16 +02:00
David Roetzel f1560f9df4
Document new environment variable (#1535) 2024-09-24 18:55:20 +02:00
Tim Campbell da08916e2a
Added documentation for additional OTEL service name customization (#1534) 2024-09-23 11:13:44 +02:00
Claire 061ad3d7ba
Document `attributionDomains` (#1532) 2024-09-17 12:16:10 +02:00
Claire 2dd9d6a3e0
Add documentation for `/api/v2/notifications/:group_key/accounts` (#1531)
Also fixes a few URLs that were still referencing `v2_alpha`
2024-09-17 11:56:35 +02:00
Claire 49546c285a
Add documentation for `/api/v2/notifications/*` (#1530)
* Add documentation for `/api/v2/notifications/*`

This is a renamed and slightly updated version of https://docs.joinmastodon.org/methods/notifications_alpha/

* Update notifications_alpha.md to point to the finalized API
2024-09-17 11:39:57 +02:00
alxhu 599173ae8c
Add hint to allocate more memory if Elasticsearch crashes (#1456)
Add tip to allocate more memory if Elasticsearch crashes to elasticsearch.md

When creating Elasticsearch indicies, the process could crash if there is not enough memory allocated to the JVM runtime.

This commit adds a hint for administrators to try to allocate more memory to Elasticsearch if they're experiencing out-of-memory issues.
2024-09-13 02:25:19 -07:00
David Roetzel 54659f9371
Deprecate redis namespace (#1528)
* Deprecate `REDIS_NAMESPACE`

* Update content/en/admin/config.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-09-06 17:19:28 +02:00
David Roetzel 3b06fdb018
Redis sentinel docs (#1527)
* Add basic Redis Sentinel documentation (#1311)

* Add basic Redis Sentinel documentation

Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>

* Add missing redis environment variables

And adjust and clarify a few things.

* Fix copy&paste error.

---------

Co-authored-by: Gabriel Simmer <github@gmem.ca>
Co-authored-by: Andy Piper <andypiper@users.noreply.github.com>
2024-09-05 17:29:14 +02:00
Mahan b780066232
Update rule_ids type in /v1/reports (#1467)
* Update rule_ids type in /v1/reports

* add reference to the ID docs
2024-09-04 10:10:53 +02:00
aaaaalbert dc78b2ad5f
Fix #1523, add missing link to `entities/Status` (#1524)
Add a link in the attribute description of `reblog` for the `Status` API entity which was reported missing by @nikclayton.
2024-08-30 11:38:44 +02:00
Claire 7eefdcbfc6
Add documentation for `grouped_types` parameter in grouped notifications endpoints (#1525) 2024-08-30 09:47:09 +02:00
Michael Stanclift 2dfcf2c059
Add config for MASTODON_USE_LIBVIPS (#1463)
* Docs for using libvips

* "utilizating"
2024-08-26 10:40:37 +02:00
Claire 24dd81ef49
Add documentation for `authors` attribute in preview cards (#1512)
* Add documentation for `authors` attribute in preview cards

* Add `PreviewCardAuthor` entity

* Update PreviewCard.md

* Update PreviewCardAuthor.md
2024-08-23 17:34:28 +02:00
Claire 54f7d5a63f
Add documentation for `/api/v2_alpha/notifications` (#1517)
* Add rough documentation for `/api/v2_alpha/notifications`

* Update notifications_alpha.md

* Add very rough documentation about notification groups entities

* Add documentation for `NotificationGroup` entity

* Document pagination-only `NotificationGroup` attributes

* Fix documentation issue with `/api/v2_alpha/notifications/:group_key` and add example output

* Add blurb about the goal of grouped notifications

* Update notifications_alpha.md

* Specify that the 80 limit is for notification groups, not notifications

* Add documentation for `group_key` to `Notification` entity

* Make `max_id`, `since_id` and `min_id` more explicit
2024-08-23 16:51:12 +02:00
Renaud Chaput 8d67de74f9
Add OTEL configuration, and deprecate StatsD (#1518) 2024-08-23 16:02:37 +02:00
Claire 12c37c8f15
Add documentation for `notifications_merged` streaming event (#1513) 2024-08-23 15:12:45 +02:00
Claire a98ee3515a
Add documentation for `/api/v1/notifications/requests/merged` (#1516)
* Add documentation for `/api/v1/notifications/requests/merged`

* Apply review suggestions

Co-authored-by: David Roetzel <david@roetzel.de>

---------

Co-authored-by: David Roetzel <david@roetzel.de>
2024-08-23 10:36:44 +02:00
Claire d94ac10884
Add documentation for bulk operations on notification requests (#1511)
* Add documentation for bulk operations on notification requests

* Apply suggestions from code review
2024-08-23 09:37:27 +02:00
Claire cff9085e39
Add documentation for `api_versions` on `Instance` entity (#1514) 2024-08-23 09:19:48 +02:00
Renaud Chaput 9b6dbb491e
Add documentation for the new `icons` attribute in `/api/v2/instances` (#1510) 2024-08-22 17:52:50 +02:00
David Roetzel 495285ba35
Clarify `scope` parameter of oauth token creation (#1509)
* Clarify `scope` parameter of oauth token creation

* Improve wording

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-08-22 15:12:45 +02:00
Michael Stanclift 1d43a44b22
Update color scheme to match latest design system (#1508)
* import variables from main UI

* apply colors

* change hint styles

* update table styling

* remove box shadow from images

* update sponsor and page ref styles

* change code highlighting theme to add more contrast

* replace link icon with google material svg

* replace fontawesome with google material icons

* remove fa assets

* fix missing mastodon fa icon in footer

* tweak alignment of hint svg icons

* tweak inline code background
2024-08-22 12:46:16 +01:00
Claire b59b7fea62
Add documentation for `/api/v2/notifications/policy` (#1503)
* Rename `NotificationPolicy` entity to `V1::NotificationPolicy`

* Add documentation for v2 NotificationPolicy

* Add deprecation warning
2024-08-22 11:20:40 +02:00
Eva Tatarka d1899d20fb
Add missing array syntax to follow lanagues query param (#1502) 2024-08-21 23:30:12 +01:00
Marcin Mikołajczak f5a1f6bef4
filters API methods: Fix typo (#1493) 2024-08-21 23:29:38 +01:00
aaaaalbert dfad4e447b
Add link to Hugo's repo in README (#1506) 2024-08-21 00:59:32 +01:00
John Haugabook 035e49f13b
Note on hugo latest release (#1501)
* Note on hugo latest release
Changed hugo link to match use docs.joinmastodon.org hugo version.
2024-08-09 11:21:18 +01:00
Andy Piper 824c7217dd
Update deploy.yml (#1496)
Update Action to use newer Hugo
2024-08-07 12:09:05 +02:00
aaaaalbert e2a3d5a63d
Fix #1490, Hugo deprecating `.Page.File.Lang` (#1491)
* Update single.html, index.html, footer.html
2024-08-03 17:59:48 +01:00
aaaaalbert 122e461f6f
Change {{< type shortcode to {{% (#1489)
Fix #1487, work around an error in the rendering of a {{< type shortcode in the autogenerated Table of Content of a page.
2024-08-03 17:58:00 +01:00
Claire 1f59ac9fde
Add documentation for `/api/v1/notifications/unread_count` (#1492)
* Add documentation for `/api/v1/notifications`

* Fix issues following review feedback

* Document unread_count's return type
2024-08-02 15:36:31 +02:00