1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-23 12:59:11 -05:00
forgejo/docs/content/doc/administration/search-engines-indexation.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

1.1 KiB

date title slug weight toc draft aliases menu
2019-12-31T13:55:00+05:00 Search Engines Indexation search-engines-indexation 60 false false
/en-us/search-engines-indexation
sidebar
parent name weight identifier
administration Search Engines Indexation 60 search-engines-indexation

Search engines indexation of your Gitea installation

By default your Gitea installation will be indexed by search engines. If you don't want your repository to be visible for search engines read further.

Block search engines indexation using robots.txt

To make Gitea serve a custom robots.txt (default: empty 404) for top level installations, create a file called robots.txt in the [custom folder or CustomPath]({{< relref "doc/administration/customizing-gitea.en-us.md" >}})

Examples on how to configure the robots.txt can be found at https://moz.com/learn/seo/robotstxt.

User-agent: *
Disallow: /

If you installed Gitea in a subdirectory, you will need to create or edit the robots.txt in the top level directory.

User-agent: *
Disallow: /gitea/