2024-11-05 13:36:43 +00:00
|
|
|
INHERIT: ../../../mkdocs.yml
|
|
|
|
|
site_name: "GoToSocial 文档"
|
|
|
|
|
theme:
|
|
|
|
|
language: zh
|
|
|
|
|
custom_dir: ../../overrides
|
|
|
|
|
palette:
|
|
|
|
|
- scheme: slate
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/brightness-7
|
|
|
|
|
name: 切换到浅色模式
|
|
|
|
|
- scheme: default
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/brightness-4
|
|
|
|
|
name: 切换到深色模式
|
|
|
|
|
docs_dir: .
|
|
|
|
|
edit_uri: edit/main/docs/locales/zh/
|
|
|
|
|
copyright: GoToSocial 以 GNU AGPL v3 许可授权。版权所有 (C) 全体 GoToSocial 开发者 admin@gotosocial.org
|
|
|
|
|
|
|
|
|
|
exclude_docs: |
|
|
|
|
|
repo/**
|
|
|
|
|
|
|
|
|
|
nav:
|
|
|
|
|
- "主页": "index.md"
|
|
|
|
|
- "FAQ": "faq.md"
|
|
|
|
|
- "使用指南":
|
|
|
|
|
- "user_guide/settings.md"
|
|
|
|
|
- "user_guide/posts.md"
|
|
|
|
|
- "user_guide/search.md"
|
|
|
|
|
- "user_guide/custom_css.md"
|
|
|
|
|
- "user_guide/password_management.md"
|
|
|
|
|
- "user_guide/rss.md"
|
|
|
|
|
- "user_guide/migration.md"
|
2025-03-10 09:24:37 +00:00
|
|
|
- "user_guide/importing_posts.md"
|
2024-11-05 13:36:43 +00:00
|
|
|
- "开始部署":
|
|
|
|
|
- "getting_started/index.md"
|
|
|
|
|
- "getting_started/releases.md"
|
|
|
|
|
- "安装":
|
|
|
|
|
- "getting_started/installation/index.md"
|
|
|
|
|
- "getting_started/installation/metal.md"
|
|
|
|
|
- "getting_started/installation/container.md"
|
|
|
|
|
- "反向代理":
|
|
|
|
|
- "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"
|
|
|
|
|
- "配置":
|
|
|
|
|
- "configuration/index.md"
|
|
|
|
|
- "configuration/general.md"
|
2025-02-09 18:13:08 +08:00
|
|
|
- "configuration/trusted_proxies.md"
|
2024-11-05 13:36:43 +00:00
|
|
|
- "configuration/database.md"
|
|
|
|
|
- "configuration/web.md"
|
|
|
|
|
- "configuration/instance.md"
|
|
|
|
|
- "configuration/accounts.md"
|
|
|
|
|
- "configuration/media.md"
|
|
|
|
|
- "configuration/storage.md"
|
|
|
|
|
- "configuration/statuses.md"
|
|
|
|
|
- "configuration/tls.md"
|
|
|
|
|
- "configuration/oidc.md"
|
|
|
|
|
- "configuration/smtp.md"
|
|
|
|
|
- "configuration/syslog.md"
|
|
|
|
|
- "configuration/httpclient.md"
|
|
|
|
|
- "configuration/advanced.md"
|
[chore/docs] Fix Prometheus metric names for Gin, include example Grafana dash, update docs (#4443)
# Description
> If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.
>
> If this is a documentation change, please briefly describe what you've changed and why.
This pull request updates some of our inconsistent metric naming, and adds an example Grafana dashboard using all the most up-to-date metrics names, and updates our docs to describe the latest way of setting up metrics.
Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4362
Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4055
## Checklist
Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]`
If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).
- [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md).
- [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
- [x] I/we have not leveraged AI to create the proposed changes.
- [x] I/we have performed a self-review of added code.
- [x] I/we have written code that is legible and maintainable by others.
- [x] I/we have commented the added code, particularly in hard-to-understand areas.
- [x] I/we have made any necessary changes to documentation.
- [ ] I/we have added tests that cover new code.
- [x] I/we have run tests and they pass locally with the changes.
- [x] I/we have run `go fmt ./...` and `golangci-lint run`.
Co-authored-by: kim <grufwub@gmail.com>
Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4443
Reviewed-by: kim <gruf@noreply.codeberg.org>
Co-authored-by: tobi <tobi.smethurst@protonmail.com>
Co-committed-by: tobi <tobi.smethurst@protonmail.com>
2025-09-18 16:48:45 +02:00
|
|
|
- "configuration/observability_and_metrics.md"
|
2024-11-05 13:36:43 +00:00
|
|
|
- "进阶":
|
|
|
|
|
- "概述": "advanced/index.md"
|
|
|
|
|
- "advanced/host-account-domain.md"
|
|
|
|
|
- "advanced/outgoing-proxy.md"
|
|
|
|
|
- "缓存":
|
|
|
|
|
- "advanced/caching/index.md"
|
|
|
|
|
- "advanced/caching/api.md"
|
|
|
|
|
- "advanced/caching/assets-media.md"
|
|
|
|
|
- "advanced/certificates.md"
|
|
|
|
|
- "安全加固":
|
|
|
|
|
- "advanced/security/index.md"
|
|
|
|
|
- "advanced/security/sandboxing.md"
|
|
|
|
|
- "advanced/security/firewall.md"
|
|
|
|
|
- "advanced/healthchecks.md"
|
|
|
|
|
- "advanced/tracing.md"
|
|
|
|
|
- "advanced/metrics.md"
|
|
|
|
|
- "advanced/replicating-sqlite.md"
|
|
|
|
|
- "advanced/sqlite-networked-storage.md"
|
|
|
|
|
- "适用进阶场景的构建":
|
|
|
|
|
- "advanced/builds/nowasm.md"
|
|
|
|
|
|
|
|
|
|
- "管理":
|
|
|
|
|
- "admin/settings.md"
|
|
|
|
|
- "admin/signups.md"
|
|
|
|
|
- "admin/federation_modes.md"
|
|
|
|
|
- "admin/domain_blocks.md"
|
2025-02-09 18:13:08 +08:00
|
|
|
- "admin/domain_permission_subscriptions.md"
|
2024-11-05 13:36:43 +00:00
|
|
|
- "admin/request_filtering_modes.md"
|
|
|
|
|
- "admin/robots.md"
|
|
|
|
|
- "admin/cli.md"
|
|
|
|
|
- "admin/backup_and_restore.md"
|
|
|
|
|
- "admin/media_caching.md"
|
|
|
|
|
- "admin/spam.md"
|
|
|
|
|
- "admin/database_maintenance.md"
|
|
|
|
|
- "admin/themes.md"
|
|
|
|
|
- "联合":
|
|
|
|
|
- "federation/index.md"
|
|
|
|
|
- "federation/http_signatures.md"
|
|
|
|
|
- "federation/access_control.md"
|
|
|
|
|
- "federation/ratelimiting.md"
|
|
|
|
|
- "federation/actors.md"
|
|
|
|
|
- "federation/posts.md"
|
2025-03-10 09:24:37 +00:00
|
|
|
- "federation/interaction_policy.md"
|
2024-11-05 13:36:43 +00:00
|
|
|
- "federation/moderation.md"
|
|
|
|
|
- "federation/glossary.md"
|
|
|
|
|
- "客户端 API 文档":
|
|
|
|
|
- "api/authentication.md"
|
|
|
|
|
- "api/swagger.md"
|
|
|
|
|
- "api/ratelimiting.md"
|
|
|
|
|
- "api/throttling.md"
|
