Mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-10-31 22:40:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
gotosocial/mkdocs.yml

150 lines
4.3 KiB
YAML
Raw Normal View History

Oidc (#109) * add oidc config * inching forward with oidc idp * lil webfingy fix * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * add oidc config * inching forward with oidc idp * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * document * docs + comments
2021-07-23 09:36:28 +01:00
site_name: GoToSocial Documentation
[docs] Add site_url for absolute 404 page assets (#1544)
2023-02-21 08:01:10 +00:00
site_url: https://docs.gotosocial.org
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 22:09:17 +00:00
theme:
name: material
language: en
font: false
features:
- header.autohide
[docs] support copy/pasta for code blocks (#1818) Co-authored-by: decentral1se <cellarspoon@riseup.net>
2023-05-23 10:51:43 +01:00
- content.code.copy
[docs] Activate the edit feature (#1967) We already set edit_uri, but we forgot to enable the feature flag. By turning it on each page now gets an edit button on the right hand side of the page header. This'll open the edit view in GitHub.
2023-07-09 17:25:14 +01:00
- content.action.edit
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 22:09:17 +00:00
palette:
- scheme: slate
toggle:
icon: material/brightness-7
name: Switch to light mode
- scheme: default
toggle:
icon: material/brightness-4
name: Switch to dark mode
Oidc (#109) * add oidc config * inching forward with oidc idp * lil webfingy fix * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * add oidc config * inching forward with oidc idp * bit more progress * further oidc * oidc now working * document dex config * replace broken images * add additional credits * tiny doc update * update * document * docs + comments
2021-07-23 09:36:28 +01:00
repo_url: https://github.com/superseriousbusiness/gotosocial
[docs] Fix documentation edit link (#1298)
2023-01-04 09:39:26 +00:00
edit_uri: edit/main/docs/
[chore/docs] Replace specific year range of copyright notice (#2520)
2024-01-13 15:33:53 +00:00
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) GoToSocial Authors admin@gotosocial.org
Swagger (#124) * start experimenting with swagger documentation * further adventures in swagger * do a few more api paths * account paths documented * go fmt * fix up some models * bit o lintin'
2021-07-31 16:49:59 +01:00
plugins:
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 22:09:17 +00:00
- search:
lang: en
- social:
cards: true
[docs] Enable some new features (#2623) * [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-02-12 11:05:35 +00:00
cards_layout_options:
background_color: "#fd6a00"
color: "#fafaff"
[chore] Vendor mkdocs fonts; update docs dependencies (#2789) * [chore] Update docs dependencies * update rtd deps * aaaa * why can't you just be normal! * vendor social plugin fonts
2024-03-29 09:52:46 +00:00
cache_dir: "./docs/.cache/plugin/social"
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 22:09:17 +00:00
- swagger-ui-tag:
supportedSubmitMethods: []
syntaxHighlightTheme: obsidian
[docs] Rework README a bit, import into docs (#3006)
2024-06-13 22:21:41 +01:00
- include-markdown
Swagger (#124) * start experimenting with swagger documentation * further adventures in swagger * do a few more api paths * account paths documented * go fmt * fix up some models * bit o lintin'
2021-07-31 16:49:59 +01:00
extra_css:
[feature] Use Material theme for docs (#1535) * [feature] Use Material theme for docs This changes the theme to use Material with the slate (dark) theme and the accent colour set to orange. It also replaces the swagger plugin with one that works correctly with the Material theming. * Add theme by @f0x52 Co-authored-by: f0x52 <f0x@cthu.lu> * Enable social cards The dependencies for cairosvg and pillow can be satisfied on RTD, so this adds them to our requirements.txt and enables the social plugin. This generates opengraph and twitter card tags as well as fancy preview images in GTS colour style for platforms that show that as part of link previews. * Update Conda environment.yml * update theme for swagger, basic light theme option * dark mode mobile header bg color --------- Co-authored-by: f0x52 <f0x@cthu.lu>
2023-02-20 22:09:17 +00:00
- assets/css/colours.css
markdown_extensions:
- admonition
[docs] Enable some new features (#2623) * [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-02-12 11:05:35 +00:00
- pymdownx.details
[docs] code highlighting configuration (#1817) Co-authored-by: decentral1se <cellarspoon@riseup.net>
2023-05-23 16:04:00 +01:00
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
[docs] Enable some new features (#2623) * [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-02-12 11:05:35 +00:00
linenums_style: pymdownx-inline
[docs] code highlighting configuration (#1817) Co-authored-by: decentral1se <cellarspoon@riseup.net>
2023-05-23 16:04:00 +01:00
pygments_lang_class: true
[docs] Enable some new features (#2623) * [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-02-12 11:05:35 +00:00
linenums: true
[docs] code highlighting configuration (#1817) Co-authored-by: decentral1se <cellarspoon@riseup.net>
2023-05-23 16:04:00 +01:00
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
[docs] Enable some new features (#2623) * [docs] Enable a bunch of markdown extensions * details makes admonitions collapsible and when started with ??? instead of !!! they'll be collpased by default * highlights are updated to include linenums by default but with a style that doesn't result in the linenums to be copy-pasted when selecting and pasting. This makes it possible to directly link to a specific line in the documentation instead of just the general page * caret, mark and tilde make it possible to highlight text and have super/subscripts * keys turns combos like `++ctrl+alt+del++` into HTML key elements showing a keyboard combination to press * tabbed makes it possible to have tabs within a document. Right now we have different sections sometimes to show the config for nginx, apache and Caddy, which can be turned into tabs instead and which tab is picked will get remebered * smartsymbols turns certain things, like `(c)` in the right symbol © * [docs] Upgrade all the python dependencies * [docs] Explain how to update conda deps
2024-02-12 11:05:35 +00:00
- pymdownx.smartsymbols
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
nav:
- "Home": "index.md"
[docs] Add first draft of FAQ (#1086) * Clarify that gotosocial doesn't use recommendation algorithms It uses lots of algorithms. ~/src/gotosocial $ rgrep algorithm . | wc 856 8971 143395 * Add first draft of the FAQ. * Suggested FAQ changes. Mention backfill of posts as not yet being implemented; link to FAQ from readme/index. Mention that GtS does serve up some UI; just not most interaction.
2022-11-21 12:19:51 +00:00
- "FAQ": "faq.md"
[docs] Add user settings panel docs, other small updates (#768) * add more links to markdown section * update password management * add user settings panel documentation * move the user guide higher up in the docs
2022-08-26 16:40:54 +01:00
- "User Guide":
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "user_guide/settings.md"
[feature] Allow users to set default interaction policies per status visibility (#3108) * [feature] Allow users to set default interaction policies * use vars for default policies * avoid some code repetition * unfuck form binding * avoid bonkers loop * beep boop * put policyValsToAPIPolicyVals in separate function * don't bother with slices.Grow * oops
2024-07-17 15:46:52 +01:00
- "user_guide/posts.md"
[feature] Add from: search operator and account_id query param (#2943) * Add from: search operator * Fix whitespace in Swagger YAML comment * Move query parsing into its own method * Document search * Clarify post search scope
2024-05-31 11:57:42 +01:00
- "user_guide/search.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "user_guide/custom_css.md"
- "user_guide/password_management.md"
- "user_guide/rss.md"
[docs] Add separate migration section + instructions for moving to GtS and not just away (#3139) * [docs] Add separate migration section + instructions for moving to GtS and not just away * update headings
2024-07-24 18:07:36 +01:00
- "user_guide/migration.md"
[docs] Revamp the installation guide (#1877) This tries to revamp/restructure the installation guide. It's renamed to "Getting Started" as it now contains a few more things than just the installation, especially the deployment considerations which we didn't use to spell out as much ahead of time. Installation is now a section with the guides on their own. I've removed a bit of redundancy like the user creation. I also removed the rogue reverse proxy section in the Docker guide and lifted that into the reverse proxy section.
2023-06-10 10:13:04 +01:00
- "Getting Started":
- "getting_started/index.md"
- "getting_started/releases.md"
- "Installation":
- "getting_started/installation/index.md"
- "getting_started/installation/metal.md"
- "getting_started/installation/container.md"
- "Reverse Proxy":
- "getting_started/reverse_proxy/index.md"
- "getting_started/reverse_proxy/nginx.md"
- "getting_started/reverse_proxy/apache-httpd.md"
- "getting_started/reverse_proxy/caddy.md"
- "getting_started/reverse_proxy/websocket.md"
- "getting_started/user_creation.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Configuration":
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "configuration/index.md"
- "configuration/general.md"
- "configuration/database.md"
- "configuration/web.md"
- "configuration/instance.md"
- "configuration/accounts.md"
- "configuration/media.md"
- "configuration/storage.md"
- "configuration/statuses.md"
[feature] Allow loading TLS certs from disk (#1586) Currently, GtS only supports using the built-in LE client directly for TLS. However, admins may still want to use GtS directly (so without a reverse proxy) but with certificates provided through some other mechanism. They may have some centralised way of provisioning these things themselves, or simply prefer to use LE but with a different challenge like DNS-01 which is not supported by autocert. This adds support for loading a public/private keypair from disk instead of using LE and reconfigures the server to use a TLS listener if we succeed in doing so. Additionally, being able to load TLS keypair from disk opens up the path to using a custom CA for testing purposes avoinding the need for a constellation of containers and something like Pebble or Step CA to provide LE APIs.
2023-03-04 17:24:02 +00:00
- "configuration/tls.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "configuration/oidc.md"
- "configuration/smtp.md"
- "configuration/syslog.md"
[feature] enable + document explicit IP dialer allowing/denying (#1950) * [feature] enable + document explicit IP dialer allowing/denying * lord have mercy * allee jonge * shortcut check ipv6 prefixes * comment * separate httpclient_test, export Sanitizer
2023-07-07 15:17:39 +01:00
- "configuration/httpclient.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "configuration/advanced.md"
[feature] Add a request ID and include it in logs (#1476) This adds a lightweight form of tracing to GTS. Each incoming request is assigned a Request ID which we then pass on and log in all our log lines. Any function that gets called downstream from an HTTP handler should now emit a requestID=value pair whenever it logs something. Co-authored-by: kim <grufwub@gmail.com>
2023-02-17 11:02:29 +00:00
- "configuration/observability.md"
[docs] Made Advanced its own section (#1883) * [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-12 14:38:53 +01:00
- "Advanced":
[docs] Document experimental, unsupported `nowasm` tag (#3436) * [docs] Document experimental, unsupported `nowasm` tag * change some awkward wording
2024-10-14 13:06:19 +01:00
- "Overview": "advanced/index.md"
[docs] Made Advanced its own section (#1883) * [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-12 14:38:53 +01:00
- "advanced/host-account-domain.md"
- "advanced/outgoing-proxy.md"
- "Caching":
- "advanced/caching/index.md"
- "advanced/caching/api.md"
- "advanced/caching/assets-media.md"
[docs] Add certificates and firewalling to advanced (#1888) * [docs] Add a certificates guide in Advanced This adds some documentation about the process of getting certificates through ACME in general. It also provides a number of links to alternative clients and certbot deployment guides that are up to date. Slightly restructure the NGINX and Apache reverse proxy documentation and insert mentions to the Provisioning TLS certificates advanced documentation in them. * [docs] Add firewall section in Advanced * [docs] Add new guides to section indexes * [docs] Fix spelling issue * [docs] Fix a few typos
2023-06-13 15:30:09 +01:00
- "advanced/certificates.md"
[docs] Made Advanced its own section (#1883) * [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-12 14:38:53 +01:00
- "Enhanced security":
- "advanced/security/index.md"
- "advanced/security/sandboxing.md"
[docs] Add certificates and firewalling to advanced (#1888) * [docs] Add a certificates guide in Advanced This adds some documentation about the process of getting certificates through ACME in general. It also provides a number of links to alternative clients and certbot deployment guides that are up to date. Slightly restructure the NGINX and Apache reverse proxy documentation and insert mentions to the Provisioning TLS certificates advanced documentation in them. * [docs] Add firewall section in Advanced * [docs] Add new guides to section indexes * [docs] Fix spelling issue * [docs] Fix a few typos
2023-06-13 15:30:09 +01:00
- "advanced/security/firewall.md"
[feature] Add healthcheck endpoints `/livez` and `/readyz` (#2783) * [feature] Add healthcheck endpoints `/livez` and `/readyz` * use select that returns no data
2024-03-25 17:05:14 +00:00
- "advanced/healthchecks.md"
[docs] Made Advanced its own section (#1883) * [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-12 14:38:53 +01:00
- "advanced/tracing.md"
[feature] Initial Prometheus metrics implementation (#2334) * feat: Initial OTEL metrics * docs: add metrics documentation * fix: metrics endpoint conditional check * feat: metrics endpoint basic auth * fix: make metrics-auth-enabled default false * fix: go fmt helpers.gen.go * fix: add metric-related env vars to envparsing.sh * fix: metrics docs * fix: metrics related stuff in envparsing.sh * fix: metrics docs * chore: metrics docs wording * fix: metrics stuff in envparsing? * bump otel versions --------- Co-authored-by: Tsuribori <user@acertaindebian> Co-authored-by: Tsuribori <none@example.org> Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>
2023-11-20 15:43:55 +00:00
- "advanced/metrics.md"
[docs] Add optional instructions for replicating SQLite for disaster recovery (#2981) * Add optional instructions for replicating SQLite for disaster recovery * Remove references to MacOS from replicating-sqlite.md Resolve comment on review * Add mention for replicating SQLite in database_maintenance.md Adds a reference to the replicating sqlite page under database maintenance
2024-06-13 14:09:51 +01:00
- "advanced/replicating-sqlite.md"
[docs] Don't run SQLite on networked storage (#3369) * [docs] Don't run SQLite on networked storage This updates our documentation to include warnings against running SQLite on networked storage. It also slightly reorganises and consolidates some admonitions on the Getting Started page because it was getting a bit too busy with repeated information. * [docs] Reword a few things
2024-09-28 21:45:43 +01:00
- "advanced/sqlite-networked-storage.md"
[docs] Document experimental, unsupported `nowasm` tag (#3436) * [docs] Document experimental, unsupported `nowasm` tag * change some awkward wording
2024-10-14 13:06:19 +01:00
- "Advanced builds":
- "advanced/builds/nowasm.md"
[docs] Made Advanced its own section (#1883) * [docs] Made Advanced its own section This splits the Advanced page off from the Getting Started guide and makes it its own thing. It now has some additional sub-sections for bigger topics like caching and enhanced security. This also moves tracing from Getting Started to Advanced as that feels like a more appropriate location for it. The enhanced security looks a little silly with a single section, but I have guides pending for firewall configurations and I'd also like to consolidate our how to provision TLS certificates in there as we repeat this information multiple times. * [docs] Fix all my spelling errors * [docs] Inline the links in sandboxing
2023-06-12 14:38:53 +01:00
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Admin":
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "admin/settings.md"
[feature] Admin accounts endpoints; approve/reject sign-ups (#2826) * update settings panels, add pending overview + approve/deny functions * add admin accounts get, approve, reject * send approved/rejected emails * use signup URL * docs! * email * swagger * web linting * fix email tests * wee lil fixerinos * use new paging logic for GetAccounts() series of admin endpoints, small changes to query building * shuffle useAccountIDIn check *before* adding to query * fix parse from toot react error * use `netip.Addr` * put valid slices in globals * optimistic updates for account state --------- Co-authored-by: kim <grufwub@gmail.com>
2024-04-13 12:25:10 +01:00
- "admin/signups.md"
[feature] Implement explicit domain allows + allowlist federation mode (#2200) * love like winter! wohoah, wohoah * domain allow side effects * tests! logging! unallow! * document federation modes * linty linterson * test * further adventures in documentation * finish up domain block documentation (i think) * change wording a wee little bit * docs, example * consolidate shared domainPermission code * call mode once * fetch federation mode within domain blocked func * read domain perm import in streaming manner * don't use pointer to slice for domain perms * don't bother copying blocks + allows before deleting * admonish! * change wording just a scooch * update docs
2023-09-21 11:12:04 +01:00
- "admin/federation_modes.md"
- "admin/domain_blocks.md"
[feature] Add HTTP header permission section to frontend (#2893) * [feature] Add HTTP header filter section to frontend * tweak naming a bit
2024-05-05 12:47:22 +01:00
- "admin/request_filtering_modes.md"
[chore] Update robots.txt (#2856) This updates the robots.txt based on the list of the ai.robots.txt repository. We can look at automating that at some point. It's worth pointing out that some robots, namely the ones by Bytedance, are known to ignore robots.txt entirely.
2024-04-22 10:01:37 +01:00
- "admin/robots.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "admin/cli.md"
- "admin/backup_and_restore.md"
[feature] Customizable media cleaner schedule (#2304)
2023-10-30 17:35:11 +00:00
- "admin/media_caching.md"
[feature] Add experimental `instance-federation-spam-filter` option (#2685) * [chore] Move `visibility` to `filter/visibility` * [feature] Add experimental instance-federation-spam-filter option
2024-02-27 12:22:05 +00:00
- "admin/spam.md"
[docs] Add database maintenance section; update info message on ANALYZE run (sqlite) (#2756) * [chore] Limit size of ANALYZE run after migration (sqlite) * add basic db maintenance tips * update docs, analyze * amend info message a wee bit * update docs/admin/database_maintenance.md wording Co-authored-by: Daenney <daenney@users.noreply.github.com> --------- Co-authored-by: kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com> Co-authored-by: Daenney <daenney@users.noreply.github.com>
2024-03-14 17:40:36 +00:00
- "admin/database_maintenance.md"
[feature] User-selectable preset CSS themes for accounts (#2777) * [feature] User-selectable preset themes * docs, more theme stuff * lint, tests * fix css name * correct some little issues * add another theme * fix poll background * okay last theme i swear * make retrieval of apimodel themes more conventional * preallocate stylesheet slices
2024-03-25 17:32:24 +00:00
- "admin/themes.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 15:54:23 +00:00
- "Federation":
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "federation/index.md"
[docs] restructure federation section (#3038)
2024-06-25 11:04:45 +01:00
- "federation/http_signatures.md"
- "federation/access_control.md"
- "federation/ratelimiting.md"
- "federation/actors.md"
- "federation/posts.md"
- "federation/moderation.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "federation/glossary.md"
[chore/docs] Various little docs updates (#2691) * [chore/docs] Various little docs updates * Update docs/api/swagger.md Co-authored-by: Daenney <daenney@users.noreply.github.com> --------- Co-authored-by: kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com> Co-authored-by: Daenney <daenney@users.noreply.github.com>
2024-02-27 14:39:22 +00:00
- "Client API Docs":
[docs] Add oauth token authentication workflow (#2655) * add authentication workflow to docs * fixed the markdown callouts and added the new page to the mkdocs.yml * fixed the markdown callouts properly this time * applied the suggested edits * inline styles don't render in code blocks; added bash to the curl code blocks * scopes list was not rendering as a list; fixed a typo in getting your token warning * scopes can be a space separated list and not just one * apply suggested change to authentication.md Co-authored-by: Daenney <daenney@users.noreply.github.com> * applied latest suggested edits * added information on Gts scoped tokens * fixed admonition formatting --------- Co-authored-by: Daenney <daenney@users.noreply.github.com>
2024-02-24 08:41:38 +00:00
- "api/authentication.md"
[chore/docs] Various little docs updates (#2691) * [chore/docs] Various little docs updates * Update docs/api/swagger.md Co-authored-by: Daenney <daenney@users.noreply.github.com> --------- Co-authored-by: kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com> Co-authored-by: Daenney <daenney@users.noreply.github.com>
2024-02-27 14:39:22 +00:00
- "api/swagger.md"
[docs] Update user/admin settings docs (#1491) * update user/admin settings docs * trigger read-the-docs pr hook * update menu links * update images
2023-02-13 11:40:24 +00:00
- "api/ratelimiting.md"
- "api/throttling.md"
Reference in a new issue Copy permalink