revamp docs: improved discoverability of common help topics #16392
Conversation
Codecov Report
@@ Coverage Diff @@
## main #16392 +/- ##
==========================================
+ Coverage 44.24% 45.50% +1.26%
==========================================
Files 695 709 +14
Lines 82341 83767 +1426
==========================================
+ Hits 36429 38121 +1692
+ Misses 40014 39511 -503
- Partials 5898 6135 +237
Continue to review full report at Codecov.
|
GiteaBot
added
the
lgtm/need 2
group by topic + order by (subjective) importance of questions
noerw
changed the title
| [Swagger](https://swagger.io/) is what Gitea uses for its API. | ||
| All Gitea instances have the built-in API, though it can be disabled by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini` | ||
| For more information, refer to Gitea's [API docs]({{< relref "doc/developers/api-usage.en-us.md" >}}) | ||
| See [here]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}#customizing-the-look-of-gitea). |
There was a problem hiding this comment.
Generally best to avoid here links:
| See [here]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}#customizing-the-look-of-gitea). | |
| See the [customizing the look of gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}#customizing-the-look-of-gitea) section of our documentation. |
| The most common culprit for this is loading federated avatars. | ||
| This can be turned off by setting `ENABLE_FEDERATED_AVATAR` to `false` in your `app.ini` | ||
| Another option that may need to be changed is setting `DISABLE_GRAVATAR` to `true` in your `app.ini` |
There was a problem hiding this comment.
So we solved this particular issue when we pushed the federated avatar lookup to when the avatar is requested.
The usual cause of slowdowns right now is the last commit lookup - hopefully #16467 and #16432 will fix that one - and then it will be the diff renderer which I might be able to get to if those would get reviewed and merged.
| There is no setting for password resets. It is enabled when a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}) is configured, and disabled otherwise. | ||
| ### Issues after updating | ||
|
|
||
| Please always check the release notes / [changelog](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md) for breaking changes; we regularly have breaking changes on minor releases! |
There was a problem hiding this comment.
We really try not to have Breaking changes on minor releases...
There are breaking changes on 1.x.0 releases - we very much try not to make breaking changes on 1.x.y releases.
The main suggestion though should be to always jump to the latest minor release - that is go from:
1.13.3 -> 1.13.7 -> 1.14.5 NOT 1.13.3 -> 1.13.4 -> 1.13.5 -> ... -> 1.14.0 -> 1.14.1 ... -> 1.14.5
|
Is it active? The documents have been hugely changed recently. |
wxiaoguang
added
the
issue/needs-feedback
|
It has been stale for a long time and I can't think of a way to handling it other than closing it. Feel free to reopen if there's any new progress and I could also help. |
This PR is a general sweep over the docs to (a) bring them up to date, (b) make them more helpful
reorder content in a way that docs show the most common topics and problems at the top, to improve helpfulness of the docs
overview,configurationcategoriesupgradecategory (moveupgrade from gogstoinstallation)featurescategoryusagecategory (plenty of pages that should be inconfiguration)advancedcategory (plentry of pages that should be inusageorconfiguration)overviewconsolidate info (avoid duplication between multiple pages)
fix minor errata, update docs content, provide more detail
noexecpartitions to faq (closes Gitea wont update on web ui #14813)configurationcategory? (Documentation of Web-UI for end users #15736)