Commit Graph

18 Commits

Author SHA1 Message Date
trwnh 3628b6d434
Update content for 4.0 (part 1) (#991)
* add rules

* join date on profiles

* deprecate follow scope

* deprecate identity proofs

* familiar followers

* use definition lists instead of tables for defining activitypub properties

* reformat notifications page into markdown

* fix broken links to publicKey header

* Application website is now nullable

* update environment variables added and removed

* fix typo

* fix heading level

* min_id and max_id can be used at the same time (3.3)

* fix typo

* new tootctl options

* reformat tootctl page to use definition lists for params

* add rules and configuration to Instance

* fix typo

* refactor instance api page

* 3.3.0 duration on mutes

* 3.3.0 mute_expires_at

* improve section headings

* 3.4.0 resend email confirmation api

* 3.4.0 policy on push subscriptions

* 3.4.0 add details to account registration error

* refactor accounts api page and start adding relrefs to entity pages

* 3.4.0 accounts/lookup api

* add see also to accounts methods

* add more see-also links

* 3.5.0 appeal mod decisions

* 3.5.0 reformat reports and add category/rule_ids params

* document report entity and missing responses

* fix typos

* fix relrefs and url schema, add aliases to old urls

* add archetypes for new methods/entities

* update archetypes with see-also stubs

* clearer presentation of rate limits

* announcements api methods

* refactor apps methods

* refactor bookmarks methods + some anchors

* refactor conversations methods

* custom_emojis methods refactor

* anchors

* refactor directory methods

* refactor domain_blocks methods

* add see also to emails methods

* fix page relref shortcodes to specific methods + refactor endorsements methods

* min_id max_id

* refactor favourites methods

* refactor featured_tags methods

* refactor filters methods, make path params consistent, i18n required shortcode

* follow_requests methods

* lists methods

* markers methods

* forgot to add entity links

* media methods, also fix formatting of some json errors

* mutes methods, add more see-also links

* oembed methods

* preferences methods

* proofs methods

* push methods

* suggestions methods

* 3.5.0 add new trend types, fix formatting

* refactor streaming methods

* refactor oauth methods

* note that streaming api casts payload to string

* refactor search methods

* refactor polls methods

* remove unnecessary link

* reformat scheduled_statuses methods

* reformat timelines methods

* reformat statuses methods

* 3.5.0 editing statuses

* consistent use of array brackets in form data parameters

* update dev setup guide, add vagrant and clean up text

* add admin/accounts methods

* 3.6 role entity

* admin/accounts methods v2

* minor fix

* stub admin/reports methods

* document admin reports

* add 403 example to methods archetype

* cleanup entities for admin reports and add new attrs

* 3.6.0 domain allows methods + normalize admin entity namespace

* fix search-and-replace error

* add aliases for admin entities

* 3.6.0 canonical email blocks entity

* 3.5.0 admin/retention api

* 3.5.0 add admin::ip doc

* 3.5.0 admin/reports

* 3.6.0 admin/domain_allows

* 3.5.0 admin/dimensions

* 3.6.0 permissions and roles

* minor formatting fix

* add anchor link to headings

* checkpoint

* add update commands to dev env setup guide

* change mentions of v3.6 to v4.0

* tootctl now uses custom roles

* fix formatting

* v2 instance api

* update frontmatter, add better titles to pages

* minor wording change

* consistency

* add more aliases

* add placeholders and WIP notices

* explain link pagination and stub out todos

* switch baseURL to https

* 422 on reports with rules but category!=violation

* document bug fixes

* fix typo

* remove duplicate API method definition

* s/tootsuite/mastodon for github links

* remove unnecessary escaping

* s/tootsuite/mastodon in Entity archetype

* add missing nullable shortcode

* clarify oauth scope when requesting a user token

* api/v2/media now synchronous for images

* DISALLOW_UNAUTHENTICATED_API_ACCESS

* add undocumented env variables

* add instance domain blocks and extended description api

* add SMTP_ENABLE_STARTTLS

* add description to SMTP_ENABLE_STARTTLS

* take suggestions from open PRs

* normalize links and flavour language

* Fully document streaming API based on source code

* Add mention of MIME types

* bump to ruby 3.0.4

* clarify how to check on async media processing

* validation of replies_policy

* remove TODOs on admin account action

* EmailDomainBlocks

* IpBlocks

* Admin::DomainBlock

* remove TODOs

* following hashtags

* followed_tags

* remove reference to unused parameter

* add new oauth scopes for admin blocks and allows

* fix command signature for i18n-tasks normalize

* reformat code structure page

* document fixes for following tags (assume 4.0.3)

* Add warning about pre-4.0 hardcoded roles

* add note about case sensitivity

* remove use of 'simply' from docs

* remove reference to silencing

* add reference to IDN normalization for verified links

* add lang parameter
2022-11-20 07:34:38 +01:00
Shlee 21716a766e
typo in RAILS_LOG_LEVEL (#933)
* Update config.md

* Update config.md
2022-05-04 02:56:49 +02:00
a sapphic bunne 2c00752228
Fixed 'AUTHORIZED_FETCH_MODE' typo in english (#891) 2021-09-13 18:29:52 +02:00
Claire dfeb299d4d
Improve WEB_DOMAIN documentation (#817)
* Improve WEB_DOMAIN documentation

Explain that queries to the webfinger endpoint on the WEB_DOMAIN have to be proxied/redirected to the LOCAL_DOMAIN.

* Improve wording based on suggestions

Co-authored-by: Raphael Schweikert <any@sabberworm.com>

* Improve documentation for LOCAL_DOMAIN and WEB_DOMAIN

- Concisely explain why it cannot be changed later, stressing this isn't about your install but about remote servers.
- Add an example relating `LOCAL_DOMAIN` and `WEB_DOMAIN` to avoid confusion.
- Make it explicit that the value is optional.

Co-authored-by: Raphael Schweikert <any@sabberworm.com>
2021-04-22 18:45:08 +02:00
Eugen Rochko dbfc97e682
Revert "Slight improvements for admin docs (#856)" (#861)
This reverts commit 9beb501bac.
2021-03-04 04:16:02 +01:00
Janek 9beb501bac
Slight improvements for admin docs (#856)
* admin/install: simplify system package instructions & use sh codeblocks

No need to assume bash

* admin/config: document RAILS_ENV in more detail
2021-01-24 09:52:33 +01:00
trwnh bcf77cb795
3.3.0rc2 (#834)
* add identifier for troubleshooting pages

* mention mutes can be temporary now

* bell for notifications

* convert images to jpg and rename them

* suspensions now reversible

* unread notifications

* suspended: true

* mutes expiry

* replies_policy, type of notification

* notify

* featuredTags AP representation

* new env vars

* accounts merge

* maintenance cli

* list replies

* suspended flag

* follower sync

* minor formatting

* add note about idempotency of follow action

* account featured tags, min_id and max_id, plus normalization

* follow marcin and nightpool's suggestion

* bearcaps

* replies_policy update

* featuredtags now have a url
2020-12-27 07:03:55 +01:00
KT f36d1f9b58
Add DB_SSLMODE to config page (#812)
* Add DB_SSLMODE to config page

* Add DB_SSLMODE for zh-cn
2020-09-23 19:37:10 +02:00
Eugen Rochko 3375a76538 Add documentation on how to proxy S3 through nginx 2020-07-26 23:45:00 +02:00
Eugen Rochko 1b2f466db1 Fix ElasticSearch documentation 2020-07-26 22:55:38 +02:00
Eugen Rochko 9a756a0947 Write out more documentation 2020-07-26 01:46:40 +02:00
Eugen Rochko 56a2e068ce Add more documentation 2020-07-25 18:04:22 +02:00
Eugen Rochko 75e9f9585a Add more configuration documentation 2020-07-25 17:51:43 +02:00
trwnh 00277c3e36
3.2.0rc1 (#795)
* add blurhash to card entity

* update tootctl

* env vars

* local/web domain

* revert http_proxy
2020-07-25 16:35:41 +02:00
trwnh 17143bad72
update for 3.1 (#785) 2020-07-01 02:11:40 +02:00
ThibG ae93e4b66d Document AUTHORIZED_FETCH and WHITELIST_MODE (#750)
* Document AUTHORIZED_FETCH and WHITELIST_MODE

* Make headings out of the documented env variables
2020-01-22 20:01:37 +01:00
trwnh 7ceae9fe36 Update anchors, line breaks, tootctl options (#745)
* update anchors

* remove extraneous anchors

* fix line breaks

* wrap tootctl tokens in code blocks

* change anchors to hugo format

* fix mistaken search-and-replace

* fix mistaken search-and-replace
2020-01-12 14:11:56 +01:00
Eugen Rochko 33cb69ad07 Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00