SuperSeriousBusiness
/
GoToSocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
GoToSocial/mkdocs.yml

115 lines
3.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 10:36:28 +02:00
site_name: GoToSocial Documentation
[docs] Add site_url for absolute 404 page assets (#1544)
2023-02-21 09:01:10 +01: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 23:09:17 +01: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 11:51:43 +02: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 18:25:14 +02: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 23:09:17 +01: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 10:36:28 +02:00
repo_url: https://github.com/superseriousbusiness/gotosocial
[docs] Fix documentation edit link (#1298)
2023-01-04 10:39:26 +01:00
edit_uri: edit/main/docs/
[chore] Update/add license headers for 2023 (#1304)
2023-01-05 12:43:00 +01:00
copyright: GoToSocial is licensed under the GNU AGPL v3 LICENSE. Copyright (C) 2021-2023 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 17:49:59 +02: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 23:09:17 +01:00
- search:
lang: en
- social:
cards: true
cards_color:
fill: "#fd6a00"
text: "#fafaff"
- swagger-ui-tag:
supportedSubmitMethods: []
syntaxHighlightTheme: obsidian
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 17:49:59 +02: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 23:09:17 +01:00
- assets/css/colours.css
markdown_extensions:
- admonition
[docs] code highlighting configuration (#1817) Co-authored-by: decentral1se <cellarspoon@riseup.net>
2023-05-23 17:04:00 +02:00
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 13:19:51 +01: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 17:40:54 +02: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 12:40:24 +01:00
- "user_guide/posts.md"
- "user_guide/settings.md"
- "user_guide/custom_css.md"
- "user_guide/password_management.md"
- "user_guide/rss.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 11:13:04 +02: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 16:54:23 +01: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 12:40:24 +01: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 18:24:02 +01: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 12:40:24 +01: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 16:17:39 +02: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 12:40:24 +01: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 12:02:29 +01: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 15:38:53 +02:00
- "Advanced":
- "advanced/index.md"
- "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 16:30:09 +02: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 15:38:53 +02: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 16:30:09 +02:00
- "advanced/security/firewall.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 15:38:53 +02:00
- "advanced/tracing.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 12:40:24 +01:00
- "admin/settings.md"
- "admin/cli.md"
- "admin/backup_and_restore.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01: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 12:40:24 +01:00
- "federation/index.md"
- "federation/glossary.md"
[docs] move federating with gotosocial documentation into single file (#1494)
2023-02-13 18:34:44 +01:00
- "federation/federating_with_gotosocial.md"
Update docs with better config + installation instructions (#300) * start reworking some documentation * fuller documentation + better docs structure
2021-11-14 16:54:23 +01:00
- "API Documentation":
[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 12:40:24 +01:00
- "api/swagger.md"
- "api/ratelimiting.md"
- "api/throttling.md"